SharePointPnP.PowerShell.Online.Commands.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPAlert</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Adds an alert for a user to a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPAlert</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPAlert</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Alert title</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User to create the alert for (User ID, login name or actual User object). Skip this parameter to create an alert for the current user. Note: Only site owners can create alerts for other users.</maml:para> </maml:description> <command:parameterValue required="true">UserPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DeliveryMethod</maml:name> <maml:description> <maml:para>Alert delivery method</maml:para> </maml:description> <command:parameterValue required="true">AlertDeliveryChannel</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ChangeType</maml:name> <maml:description> <maml:para>Alert change type</maml:para> </maml:description> <command:parameterValue required="true">AlertEventType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Frequency</maml:name> <maml:description> <maml:para>Alert frequency</maml:para> </maml:description> <command:parameterValue required="true">AlertFrequency</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Alert filter</maml:para> </maml:description> <command:parameterValue required="true">AlertFilter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Time</maml:name> <maml:description> <maml:para>Alert time (if frequency is not immediate)</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ChangeType</maml:name> <maml:description> <maml:para>Alert change type</maml:para> </maml:description> <command:parameterValue required="false">AlertEventType</command:parameterValue> <dev:type> <maml:name>AlertEventType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DeliveryMethod</maml:name> <maml:description> <maml:para>Alert delivery method</maml:para> </maml:description> <command:parameterValue required="false">AlertDeliveryChannel</command:parameterValue> <dev:type> <maml:name>AlertDeliveryChannel</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Alert filter</maml:para> </maml:description> <command:parameterValue required="false">AlertFilter</command:parameterValue> <dev:type> <maml:name>AlertFilter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Frequency</maml:name> <maml:description> <maml:para>Alert frequency</maml:para> </maml:description> <command:parameterValue required="false">AlertFrequency</command:parameterValue> <dev:type> <maml:name>AlertFrequency</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Time</maml:name> <maml:description> <maml:para>Alert time (if frequency is not immediate)</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Alert title</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User to create the alert for (User ID, login name or actual User object). Skip this parameter to create an alert for the current user. Note: Only site owners can create alerts for other users.</maml:para> </maml:description> <command:parameterValue required="false">UserPipeBind</command:parameterValue> <dev:type> <maml:name>UserPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.AlertCreationInformation</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPAlert -List "Demo List"</dev:code> <maml:remarks> <maml:para>Adds a new alert to the "Demo List" for the current user.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPAlert -Title "Daily summary" -List "Demo List" -Frequency Daily -ChangeType All -Time (Get-Date -Hour 11 -Minute 00 -Second 00)</dev:code> <maml:remarks> <maml:para>Adds a daily alert for the current user at the given time to the "Demo List". Note: a timezone offset might be applied so please verify on your tenant that the alert indeed got the right time.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPAlert -Title "Alert for user" -List "Demo List" -User "i:0#.f|membership|Alice@contoso.onmicrosoft.com"</dev:code> <maml:remarks> <maml:para>Adds a new alert for user "Alice" to the "Demo List". Note: Only site owners and admins are permitted to set alerts for other users.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPApp</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Add/uploads an available app to the app catalog</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPApp</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPApp</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the Id or an actual app metadata instance</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="true">AppCatalogScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrites the existing app package if it already exists</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the timeout in seconds. Defaults to 200.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPApp</maml:name> <command:parameter required="true" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>This will deploy/trust an app into the app catalog</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the Id or an actual app metadata instance</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipFeatureDeployment</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="true">AppCatalogScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrites the existing app package if it already exists</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the timeout in seconds. Defaults to 200.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrites the existing app package if it already exists</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the Id or an actual app metadata instance</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>This will deploy/trust an app into the app catalog</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="false">AppCatalogScope</command:parameterValue> <dev:type> <maml:name>AppCatalogScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipFeatureDeployment</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the timeout in seconds. Defaults to 200.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OfficeDevPnP.Core.ALM.AppMetadata</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPApp -Path ./myapp.sppkg</dev:code> <maml:remarks> <maml:para>This will upload the specified app package to the app catalog</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPApp -Path ./myapp.sppkg -Publish</dev:code> <maml:remarks> <maml:para>This will upload the specified app package to the app catalog and deploy/trust it at the same time.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPApp -Path ./myapp.sppkg -Scope Site -Publish</dev:code> <maml:remarks> <maml:para>This will upload the specified app package to the site collection app catalog and deploy/trust it at the same time.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPApplicationCustomizer</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Adds a SharePoint Framework client side extension application customizer</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPApplicationCustomizer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds a SharePoint Framework client side extension application customizer by registering a user custom action to a web or sitecollection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPApplicationCustomizer</maml:name> <command:parameter required="true" position="named"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the application customizer</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the application customizer</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this application customizer being injected. Use when you have a specific sequence with which to have multiple application customizers being added to the page.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties of the application customizer. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}"</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideHostProperties</maml:name> <maml:description> <maml:para>The Client Side Host Properties of the application customizer. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}"</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties of the application customizer. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}"</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideHostProperties</maml:name> <maml:description> <maml:para>The Client Side Host Properties of the application customizer. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}"</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the application customizer</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command.</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this application customizer being injected. Use when you have a specific sequence with which to have multiple application customizers being added to the page.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the application customizer</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-PnPApplicationCustomizer -Title "CollabFooter" -ClientSideComponentId c0ab3b94-8609-40cf-861e-2a1759170b43 -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"}</dev:code> <maml:remarks> <maml:para>Adds a new application customizer to the current web. This requires that a SharePoint Framework solution has been deployed containing the application customizer specified in its manifest. Be sure to run Install-PnPApp before trying this cmdlet on a site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPClientSidePage</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Adds a Client-Side Page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPClientSidePage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPClientSidePage</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the page.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LayoutType</maml:name> <maml:description> <maml:para>Specifies the layout type of the page.</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePageLayoutType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PromoteAs</maml:name> <maml:description> <maml:para>Allows to promote the page for a specific purpose (HomePage | NewsPage)</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePromoteType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specify either the name, ID or an actual content type.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CommentsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables the comments on the page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Publishes the page once it is saved. Applicable to libraries set to create major and minor versions.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HeaderLayoutType</maml:name> <maml:description> <maml:para>Type of layout used for the header</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePageHeaderLayoutType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>CommentsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables the comments on the page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specify either the name, ID or an actual content type.</maml:para> </maml:description> <command:parameterValue required="false">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HeaderLayoutType</maml:name> <maml:description> <maml:para>Type of layout used for the header</maml:para> </maml:description> <command:parameterValue required="false">ClientSidePageHeaderLayoutType</command:parameterValue> <dev:type> <maml:name>ClientSidePageHeaderLayoutType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LayoutType</maml:name> <maml:description> <maml:para>Specifies the layout type of the page.</maml:para> </maml:description> <command:parameterValue required="false">ClientSidePageLayoutType</command:parameterValue> <dev:type> <maml:name>ClientSidePageLayoutType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the page.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PromoteAs</maml:name> <maml:description> <maml:para>Allows to promote the page for a specific purpose (HomePage | NewsPage)</maml:para> </maml:description> <command:parameterValue required="false">ClientSidePagePromoteType</command:parameterValue> <dev:type> <maml:name>ClientSidePagePromoteType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Publishes the page once it is saved. Applicable to libraries set to create major and minor versions.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPClientSidePage -Name "NewPage"</dev:code> <maml:remarks> <maml:para>Creates a new Client-Side page named 'NewPage'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPClientSidePage -Name "NewPage" -ContentType "MyPageContentType"</dev:code> <maml:remarks> <maml:para>Creates a new Client-Side page named 'NewPage' and sets the content type to the content type specified</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPClientSidePage -Name "NewPageTemplate" -PromoteAs Template</dev:code> <maml:remarks> <maml:para>Creates a new Client-Side page named 'NewPage' and saves as a template to the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPClientSidePage -Name "Folder/NewPage"</dev:code> <maml:remarks> <maml:para>Creates a new Client-Side page named 'NewPage' under 'Folder' folder and saves as a template to the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPClientSidePage -Name "NewPage" -HeaderLayoutType ColorBlock</dev:code> <maml:remarks> <maml:para>Creates a new Client-Side page named 'NewPage' using the ColorBlock header layout</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPClientSidePageSection</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Adds a new section to a Client-Side page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPClientSidePageSection</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPClientSidePageSection</maml:name> <command:parameter required="true" position="named"> <maml:name>SectionTemplate</maml:name> <maml:description> <maml:para>Specifies the columns template to use for the section.</maml:para> </maml:description> <command:parameterValue required="true">CanvasSectionTemplate</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the section. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ZoneEmphasis</maml:name> <maml:description> <maml:para>Sets the background of the section (default = 0)</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the section. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> <dev:type> <maml:name>ClientSidePagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SectionTemplate</maml:name> <maml:description> <maml:para>Specifies the columns template to use for the section.</maml:para> </maml:description> <command:parameterValue required="true">CanvasSectionTemplate</command:parameterValue> <dev:type> <maml:name>CanvasSectionTemplate</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ZoneEmphasis</maml:name> <maml:description> <maml:para>Sets the background of the section (default = 0)</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPClientSidePageSection -Page "MyPage" -SectionTemplate OneColumn</dev:code> <maml:remarks> <maml:para>Adds a new one-column section to the Client-Side page 'MyPage'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPClientSidePageSection -Page "MyPage" -SectionTemplate ThreeColumn -Order 10</dev:code> <maml:remarks> <maml:para>Adds a new Three columns section to the Client-Side page 'MyPage' with an order index of 10</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $page = Add-PnPClientSidePage -Name "MyPage" PS> Add-PnPClientSidePageSection -Page $page -SectionTemplate OneColumn</dev:code> <maml:remarks> <maml:para>Adds a new one column section to the Client-Side page 'MyPage'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $page = Add-PnPClientSidePage -Name "MyPage" PS> Add-PnPClientSidePageSection -Page $page -SectionTemplate OneColumn -ZoneEmphasis 2</dev:code> <maml:remarks> <maml:para>Adds a new one column section to the Client-Side page 'MyPage' and sets the background to 2 (0 is no background, 3 is highest emphasis)</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPClientSideText</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Adds a text element to a client-side page.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPClientSideText</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds a new text element to a section on a client-side page.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPClientSideText</maml:name> <command:parameter required="true" position="named"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies the text to display in the text area.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the text control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPClientSideText</maml:name> <command:parameter required="true" position="named"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies the text to display in the text area.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Section</maml:name> <maml:description> <maml:para>Sets the section where to insert the text control.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para>Sets the column where to insert the text control.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the text control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para>Sets the column where to insert the text control.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the text control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> <dev:type> <maml:name>ClientSidePagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Section</maml:name> <maml:description> <maml:para>Sets the section where to insert the text control.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies the text to display in the text area.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPClientSideText -Page "MyPage" -Text "Hello World!"</dev:code> <maml:remarks> <maml:para>Adds the text 'Hello World!' to the Client-Side Page 'MyPage'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPClientSideWebPart</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Adds a Client-Side Web Part to a client-side page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPClientSideWebPart</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds a client-side web part to an existing client-side page.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPClientSideWebPart</maml:name> <command:parameter required="true" position="named"> <maml:name>DefaultWebPartType</maml:name> <maml:description> <maml:para>Defines a default web part type to insert.</maml:para> </maml:description> <command:parameterValue required="true">DefaultClientSideWebParts</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebPartProperties</maml:name> <maml:description> <maml:para>The properties of the web part</maml:para> </maml:description> <command:parameterValue required="true">PropertyBagPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the web part control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPClientSideWebPart</maml:name> <command:parameter required="true" position="named"> <maml:name>Component</maml:name> <maml:description> <maml:para>Specifies the component instance or Id to add.</maml:para> </maml:description> <command:parameterValue required="true">ClientSideComponentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebPartProperties</maml:name> <maml:description> <maml:para>The properties of the web part</maml:para> </maml:description> <command:parameterValue required="true">PropertyBagPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the web part control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPClientSideWebPart</maml:name> <command:parameter required="true" position="named"> <maml:name>DefaultWebPartType</maml:name> <maml:description> <maml:para>Defines a default web part type to insert.</maml:para> </maml:description> <command:parameterValue required="true">DefaultClientSideWebParts</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Section</maml:name> <maml:description> <maml:para>Sets the section where to insert the web part control.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para>Sets the column where to insert the web part control.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebPartProperties</maml:name> <maml:description> <maml:para>The properties of the web part</maml:para> </maml:description> <command:parameterValue required="true">PropertyBagPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the web part control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPClientSideWebPart</maml:name> <command:parameter required="true" position="named"> <maml:name>Component</maml:name> <maml:description> <maml:para>Specifies the component instance or Id to add.</maml:para> </maml:description> <command:parameterValue required="true">ClientSideComponentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Section</maml:name> <maml:description> <maml:para>Sets the section where to insert the web part control.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para>Sets the column where to insert the web part control.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebPartProperties</maml:name> <maml:description> <maml:para>The properties of the web part</maml:para> </maml:description> <command:parameterValue required="true">PropertyBagPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the web part control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para>Sets the column where to insert the web part control.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Component</maml:name> <maml:description> <maml:para>Specifies the component instance or Id to add.</maml:para> </maml:description> <command:parameterValue required="true">ClientSideComponentPipeBind</command:parameterValue> <dev:type> <maml:name>ClientSideComponentPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DefaultWebPartType</maml:name> <maml:description> <maml:para>Defines a default web part type to insert.</maml:para> </maml:description> <command:parameterValue required="true">DefaultClientSideWebParts</command:parameterValue> <dev:type> <maml:name>DefaultClientSideWebParts</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the web part control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> <dev:type> <maml:name>ClientSidePagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Section</maml:name> <maml:description> <maml:para>Sets the section where to insert the web part control.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebPartProperties</maml:name> <maml:description> <maml:para>The properties of the web part</maml:para> </maml:description> <command:parameterValue required="false">PropertyBagPipeBind</command:parameterValue> <dev:type> <maml:name>PropertyBagPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPClientSideWebPart -Page "MyPage" -DefaultWebPartType BingMap</dev:code> <maml:remarks> <maml:para>Adds a built-in Client-Side component 'BingMap' to the page called 'MyPage'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPClientSideWebPart -Page "MyPage" -Component "HelloWorld"</dev:code> <maml:remarks> <maml:para>Adds a Client-Side component 'HelloWorld' to the page called 'MyPage'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPClientSideWebPart -Page "MyPage" -Component "HelloWorld" -Section 1 -Column 2</dev:code> <maml:remarks> <maml:para>Adds a Client-Side component 'HelloWorld' to the page called 'MyPage' in section 1 and column 2</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPContentType</command:name> <maml:description> <maml:para>Adds a new content type</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPContentType</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPContentType</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the name of the new content type</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentTypeId</maml:name> <maml:description> <maml:para>If specified, in the format of 0x0100233af432334r434343f32f3, will create a content type with the specific ID</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new content type</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the group of the new content type</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ParentContentType</maml:name> <maml:description> <maml:para>Specifies the parent of the new content type</maml:para> </maml:description> <command:parameterValue required="true">ContentType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ContentTypeId</maml:name> <maml:description> <maml:para>If specified, in the format of 0x0100233af432334r434343f32f3, will create a content type with the specific ID</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new content type</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the group of the new content type</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the name of the new content type</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ParentContentType</maml:name> <maml:description> <maml:para>Specifies the parent of the new content type</maml:para> </maml:description> <command:parameterValue required="false">ContentType</command:parameterValue> <dev:type> <maml:name>ContentType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.ContentType</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPContentType -Name "Project Document" -Description "Use for Contoso projects" -Group "Contoso Content Types" -ParentContentType $ct</dev:code> <maml:remarks> <maml:para>This will add a new content type based on the parent content type stored in the $ct variable.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPContentTypeToDocumentSet</command:name> <maml:description> <maml:para>Adds a content type to a document set</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPContentTypeToDocumentSet</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPContentTypeToDocumentSet</maml:name> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type object, name or id to add. Either specify name, an id, or a content type object.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DocumentSet</maml:name> <maml:description> <maml:para>The document set object or id to add the content type to. Either specify a name, a document set template object, an id, or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type object, name or id to add. Either specify name, an id, or a content type object.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind[]</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DocumentSet</maml:name> <maml:description> <maml:para>The document set object or id to add the content type to. Either specify a name, a document set template object, an id, or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> <dev:type> <maml:name>DocumentSetPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPContentTypeToDocumentSet -ContentType "Test CT" -DocumentSet "Test Document Set"</dev:code> <maml:remarks> <maml:para>This will add the content type called 'Test CT' to the document set called ''Test Document Set'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $docset = Get-PnPDocumentSetTemplate -Identity "Test Document Set" PS:> $ct = Get-PnPContentType -Identity "Test CT" PS:> Add-PnPContentTypeToDocumentSet -ContentType $ct -DocumentSet $docset</dev:code> <maml:remarks> <maml:para>This will add the content type called 'Test CT' to the document set called ''Test Document Set'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPContentTypeToDocumentSet -ContentType 0x0101001F1CEFF1D4126E4CAD10F00B6137E969 -DocumentSet 0x0120D520005DB65D094035A241BAC9AF083F825F3B</dev:code> <maml:remarks> <maml:para>This will add the content type called 'Test CT' to the document set called ''Test Document Set'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPContentTypeToList</command:name> <maml:description> <maml:para>Adds a new content type to a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPContentTypeToList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPContentTypeToList</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>Specifies the list to which the content type needs to be added</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specifies the content type that needs to be added to the list</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultContentType</maml:name> <maml:description> <maml:para>Specify if the content type needs to be the default content type or not</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specifies the content type that needs to be added to the list</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultContentType</maml:name> <maml:description> <maml:para>Specify if the content type needs to be the default content type or not</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>Specifies the list to which the content type needs to be added</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPContentTypeToList -List "Documents" -ContentType "Project Document" -DefaultContentType</dev:code> <maml:remarks> <maml:para>This will add an existing content type to a list and sets it as the default content type</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPCustomAction</command:name> <maml:description> <maml:para>Adds a custom action</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPCustomAction</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds a user custom action to a web or sitecollection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPCustomAction</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the custom action</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the custom action</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The actual location where this custom action need to be added like 'CommandUI.Ribbon'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the custom action</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Optional activation sequence order for the extensions. Used if multiple extensions are activated on a same scope.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RegistrationId</maml:name> <maml:description> <maml:para>The identifier of the object associated with the custom action.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RegistrationType</maml:name> <maml:description> <maml:para>Specifies the type of object associated with the custom action</maml:para> </maml:description> <command:parameterValue required="true">UserCustomActionRegistrationType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties of the custom action. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}"</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideHostProperties</maml:name> <maml:description> <maml:para>The Client Side Host Properties of the custom action. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}"</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPCustomAction</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the custom action</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the custom action</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the custom action</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group where this custom action needs to be added like 'SiteActions'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The actual location where this custom action need to be added like 'CommandUI.Ribbon'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multiple CustomActions being added to the page.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The URL, URI or ECMAScript (JScript, JavaScript) function associated with the action</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ImageUrl</maml:name> <maml:description> <maml:para>The URL of the image associated with the custom action</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CommandUIExtension</maml:name> <maml:description> <maml:para>XML fragment that determines user interface properties of the custom action</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RegistrationId</maml:name> <maml:description> <maml:para>The identifier of the object associated with the custom action.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Rights</maml:name> <maml:description> <maml:para>A string array that contain the permissions needed for the custom action</maml:para> </maml:description> <command:parameterValue required="true">PermissionKind[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RegistrationType</maml:name> <maml:description> <maml:para>Specifies the type of object associated with the custom action</maml:para> </maml:description> <command:parameterValue required="true">UserCustomActionRegistrationType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the custom action</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties of the custom action. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}"</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideHostProperties</maml:name> <maml:description> <maml:para>The Client Side Host Properties of the custom action. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}"</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CommandUIExtension</maml:name> <maml:description> <maml:para>XML fragment that determines user interface properties of the custom action</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the custom action</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group where this custom action needs to be added like 'SiteActions'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ImageUrl</maml:name> <maml:description> <maml:para>The URL of the image associated with the custom action</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The actual location where this custom action need to be added like 'CommandUI.Ribbon'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the custom action</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RegistrationId</maml:name> <maml:description> <maml:para>The identifier of the object associated with the custom action.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RegistrationType</maml:name> <maml:description> <maml:para>Specifies the type of object associated with the custom action</maml:para> </maml:description> <command:parameterValue required="false">UserCustomActionRegistrationType</command:parameterValue> <dev:type> <maml:name>UserCustomActionRegistrationType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Rights</maml:name> <maml:description> <maml:para>A string array that contain the permissions needed for the custom action</maml:para> </maml:description> <command:parameterValue required="false">PermissionKind[]</command:parameterValue> <dev:type> <maml:name>PermissionKind[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command.</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multiple CustomActions being added to the page.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the custom action</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The URL, URI or ECMAScript (JScript, JavaScript) function associated with the action</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$cUIExtn = "<CommandUIExtension><CommandUIDefinitions><CommandUIDefinition Location=""Ribbon.List.Share.Controls._children""><Button Id=""Ribbon.List.Share.GetItemsCountButton"" Alt=""Get list items count"" Sequence=""11"" Command=""Invoke_GetItemsCountButtonRequest"" LabelText=""Get Items Count"" TemplateAlias=""o1"" Image32by32=""_layouts/15/images/placeholder32x32.png"" Image16by16=""_layouts/15/images/placeholder16x16.png"" /></CommandUIDefinition></CommandUIDefinitions><CommandUIHandlers><CommandUIHandler Command=""Invoke_GetItemsCountButtonRequest"" CommandAction=""javascript: alert('Total items in this list: '+ ctx.TotalListItems);"" EnabledScript=""javascript: function checkEnable() { return (true);} checkEnable();""/></CommandUIHandlers></CommandUIExtension>" Add-PnPCustomAction -Name 'GetItemsCount' -Title 'Invoke GetItemsCount Action' -Description 'Adds custom action to custom list ribbon' -Group 'SiteActions' -Location 'CommandUI.Ribbon' -CommandUIExtension $cUIExtn</dev:code> <maml:remarks> <maml:para>Adds a new custom action to the custom list template, and sets the Title, Name and other fields with the specified values. On click it shows the number of items in that list. Notice: escape quotes in CommandUIExtension.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-PnPCustomAction -Title "CollabFooter" -Name "CollabFooter" -Location "ClientSideExtension.ApplicationCustomizer" -ClientSideComponentId c0ab3b94-8609-40cf-861e-2a1759170b43 -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"}</dev:code> <maml:remarks> <maml:para>Adds a new application customizer to the site. This requires that an SPFX solution has been deployed containing the application customizer specified. Be sure to run Install-PnPApp before trying this cmdlet on a site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>UserCustomAction:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee539583(v=office.15)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>BasePermissions:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee543321(v=office.15)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPDataRowsToProvisioningTemplate</command:name> <maml:description> <maml:para>Adds datarows to a list inside a PnP Provisioning Template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPDataRowsToProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPDataRowsToProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filename of the .PNP Open XML site template to read from, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>The CAML query to execute against the list. Defaults to all items.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>The fields to retrieve. If not specified all fields will be loaded in the returned list object.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TokenizeUrls</maml:name> <maml:description> <maml:para>If set, this switch will try to tokenize the values with web and site related tokens</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while loading the template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>IncludeSecurity</maml:name> <maml:description> <maml:para>A switch to include ObjectSecurity information.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>The fields to retrieve. If not specified all fields will be loaded in the returned list object.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>IncludeSecurity</maml:name> <maml:description> <maml:para>A switch to include ObjectSecurity information.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filename of the .PNP Open XML site template to read from, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>The CAML query to execute against the list. Defaults to all items.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while loading the template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TokenizeUrls</maml:name> <maml:description> <maml:para>If set, this switch will try to tokenize the values with web and site related tokens</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPDataRowsToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Query '<View></View>' -Fields 'Title','Choice'</dev:code> <maml:remarks> <maml:para>Adds datarows from the provided list to the PnP Provisioning Template at the provided location</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPDataRowsToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Query '<View></View>' -Fields 'Title','Choice' -IncludeSecurity</dev:code> <maml:remarks> <maml:para>Adds datarows from the provided list to the PnP Provisioning Template at the provided location</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPDocumentSet</command:name> <maml:description> <maml:para>Creates a new document set in a library.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPDocumentSet</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPDocumentSet</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The name of the list, its ID or an actual list object from where the document set needs to be added</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the document set</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The name of the content type, its ID or an actual content object referencing to the document set</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The name of the content type, its ID or an actual content object referencing to the document set</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The name of the list, its ID or an actual list object from where the document set needs to be added</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the document set</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPDocumentSet -List "Documents" -ContentType "Test Document Set" -Name "Test"</dev:code> <maml:remarks> <maml:para>This will add a new document set based upon the 'Test Document Set' content type to a list called 'Documents'. The document set will be named 'Test'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPEventReceiver</command:name> <maml:description> <maml:para>Adds a new remote event receiver</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPEventReceiver</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPEventReceiver</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the remote event receiver</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The URL of the remote event receiver web service</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EventReceiverType</maml:name> <maml:description> <maml:para>The type of the event receiver like ItemAdded, ItemAdding. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.eventreceivertype.aspx for the full list of available types.</maml:para> </maml:description> <command:parameterValue required="true">EventReceiverType</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Synchronization</maml:name> <maml:description> <maml:para>The synchronization type: Asynchronous or Synchronous</maml:para> </maml:description> <command:parameterValue required="true">EventReceiverSynchronization</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where the remote event receiver needs to be added. If omitted, the remote event receiver will be added to the web.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SequenceNumber</maml:name> <maml:description> <maml:para>The sequence number where this remote event receiver should be placed</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>EventReceiverType</maml:name> <maml:description> <maml:para>The type of the event receiver like ItemAdded, ItemAdding. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.eventreceivertype.aspx for the full list of available types.</maml:para> </maml:description> <command:parameterValue required="true">EventReceiverType</command:parameterValue> <dev:type> <maml:name>EventReceiverType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where the remote event receiver needs to be added. If omitted, the remote event receiver will be added to the web.</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the remote event receiver</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SequenceNumber</maml:name> <maml:description> <maml:para>The sequence number where this remote event receiver should be placed</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Synchronization</maml:name> <maml:description> <maml:para>The synchronization type: Asynchronous or Synchronous</maml:para> </maml:description> <command:parameterValue required="true">EventReceiverSynchronization</command:parameterValue> <dev:type> <maml:name>EventReceiverSynchronization</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The URL of the remote event receiver web service</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.EventReceiverDefinition</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPEventReceiver -List "ProjectList" -Name "TestEventReceiver" -Url https://yourserver.azurewebsites.net/eventreceiver.svc -EventReceiverType ItemAdded -Synchronization Asynchronous</dev:code> <maml:remarks> <maml:para>This will add a new remote event receiver that is executed after an item has been added to the ProjectList list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPEventReceiver -Name "TestEventReceiver" -Url https://yourserver.azurewebsites.net/eventreceiver.svc -EventReceiverType WebAdding -Synchronization Synchronous</dev:code> <maml:remarks> <maml:para>This will add a new remote event receiver that is executed while a new subsite is being created</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPField</command:name> <maml:description> <maml:para>Add a field</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPField</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds a field to a list or as a site column</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPField</maml:name> <command:parameter required="false" position="named"> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Switch Parameter if this field must be added to the default view</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para>Switch Parameter if the field is a required field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group name to where this field belongs to</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPField</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The name of the list, its ID or an actual list object where this field needs to be added</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The name of the field, its ID or an actual field object that needs to be added</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPField</maml:name> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the field like Choice, Note, MultiChoice. For a complete list of field types visit https://docs.microsoft.com/dotnet/api/microsoft.sharepoint.client.fieldtype</maml:para> </maml:description> <command:parameterValue required="true">FieldType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The name of the list, its ID or an actual list object where this field needs to be added</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the field, must be unique</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Switch Parameter if this field must be added to the default view</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para>Switch Parameter if the field is a required field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group name to where this field belongs to</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id to set to the field</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties to set to the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Choices</maml:name> <maml:description> <maml:para>Specify choices, only valid if the field type is Choice</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Formula</maml:name> <maml:description> <maml:para>Specify the formula. Only available if the field type is Calculated</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPField</maml:name> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the field like Choice, Note, MultiChoice. For a complete list of field types visit https://docs.microsoft.com/dotnet/api/microsoft.sharepoint.client.fieldtype</maml:para> </maml:description> <command:parameterValue required="true">FieldType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the field, must be unique</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id to set to the field</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties to set to the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Choices</maml:name> <maml:description> <maml:para>Specify choices, only valid if the field type is Choice</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Formula</maml:name> <maml:description> <maml:para>Specify the formula. Only available if the field type is Calculated</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Switch Parameter if this field must be added to the default view</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Choices</maml:name> <maml:description> <maml:para>Specify choices, only valid if the field type is Choice</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id to set to the field</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties to set to the field</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The name of the field, its ID or an actual field object that needs to be added</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Formula</maml:name> <maml:description> <maml:para>Specify the formula. Only available if the field type is Calculated</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group name to where this field belongs to</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the field, must be unique</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The name of the list, its ID or an actual list object where this field needs to be added</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para>Switch Parameter if the field is a required field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the field like Choice, Note, MultiChoice. For a complete list of field types visit https://docs.microsoft.com/dotnet/api/microsoft.sharepoint.client.fieldtype</maml:para> </maml:description> <command:parameterValue required="true">FieldType</command:parameterValue> <dev:type> <maml:name>FieldType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Field</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPField -Type Calculated -InternalName "C1" -DisplayName "C1" -Formula ="[Title]"</dev:code> <maml:remarks> <maml:para>Adds a new calculated site column with the formula specified</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPField -List "Demo list" -DisplayName "Location" -InternalName "SPSLocation" -Type Choice -Group "Demo Group" -AddToDefaultView -Choices "Stockholm","Helsinki","Oslo"</dev:code> <maml:remarks> <maml:para>This will add a field of type Choice to the list "Demo List".</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Add-PnPField -List "Demo list" -DisplayName "Speakers" -InternalName "SPSSpeakers" -Type MultiChoice -Group "Demo Group" -AddToDefaultView -Choices "Obiwan Kenobi","Darth Vader", "Anakin Skywalker"</dev:code> <maml:remarks> <maml:para>This will add a field of type Multiple Choice to the list "Demo List". (you can pick several choices for the same item)</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPFieldFromXml</command:name> <maml:description> <maml:para>Adds a field to a list or as a site column based upon a CAML/XML field definition</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPFieldFromXml</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFieldFromXml</maml:name> <command:parameter required="true" position="named"> <maml:name>FieldXml</maml:name> <maml:description> <maml:para>CAML snippet containing the field definition. See http://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The name of the list, its ID or an actual list object where this field needs to be added</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>FieldXml</maml:name> <maml:description> <maml:para>CAML snippet containing the field definition. See http://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The name of the list, its ID or an actual list object where this field needs to be added</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Field</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $xml = '<Field Type="Text" Name="PSCmdletTest" DisplayName="PSCmdletTest" ID="{27d81055-f208-41c9-a976-61c5473eed4a}" Group="Test" Required="FALSE" StaticName="PSCmdletTest" />' PS:> Add-PnPFieldFromXml -FieldXml $xml</dev:code> <maml:remarks> <maml:para>Adds a field with the specified field CAML code to the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $xml = '<Field Type="Text" Name="PSCmdletTest" DisplayName="PSCmdletTest" ID="{27d81055-f208-41c9-a976-61c5473eed4a}" Group="Test" Required="FALSE" StaticName="PSCmdletTest" />' PS:> Add-PnPFieldFromXml -List "Demo List" -FieldXml $xml</dev:code> <maml:remarks> <maml:para>Adds a field with the specified field CAML code to the list "Demo List".</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Field CAML:</maml:linkText> <maml:uri>http://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPFieldToContentType</command:name> <maml:description> <maml:para>Adds an existing site column to a content type</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPFieldToContentType</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFieldToContentType</maml:name> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>Specifies the field that needs to be added to the content type</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specifies which content type a field needs to be added to</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para>Specifies whether the field is required or not</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Hidden</maml:name> <maml:description> <maml:para>Specifies whether the field should be hidden or not</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specifies which content type a field needs to be added to</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>Specifies the field that needs to be added to the content type</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Hidden</maml:name> <maml:description> <maml:para>Specifies whether the field should be hidden or not</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para>Specifies whether the field is required or not</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFieldToContentType -Field "Project_Name" -ContentType "Project Document"</dev:code> <maml:remarks> <maml:para>This will add an existing site column with an internal name of "Project_Name" to a content type called "Project Document"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPFile</command:name> <maml:description> <maml:para>Uploads a file to Web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPFile</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>The local file path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The destination folder in the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NewFileName</maml:name> <maml:description> <maml:para>Filename to give the file on SharePoint</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Checkout</maml:name> <maml:description> <maml:para>If versioning is enabled, this will check out the file first if it exists, upload the file, then check it in again.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckInComment</maml:name> <maml:description> <maml:para>The comment added to the checkin.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Approve</maml:name> <maml:description> <maml:para>Will auto approve the uploaded file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ApproveComment</maml:name> <maml:description> <maml:para>The comment added to the approval.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Will auto publish the file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishComment</maml:name> <maml:description> <maml:para>The comment added to the publish action.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseWebDav</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names. Single line of text: -Values @{"Title" = "Title New"} Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} Choice: -Values @{"Choice" = "Value 1"} Number: -Values @{"Number" = "10"} Currency: -Values @{"Number" = "10"} Currency: -Values @{"Currency" = "10"} Date and Time: -Values @{"DateAndTime" = "03/10/2015 14:16"} Lookup (id of lookup value): -Values @{"Lookup" = "2"} Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} Yes/No: -Values @{"YesNo" = $false} Person/Group (id of user/group in Site User Info List or email of the user, separate multiple values with a comma): -Values @{"Person" = "user1@domain.com","21"} Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnp"}</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Use to assign a ContentType to the file.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Name for file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Stream</maml:name> <maml:description> <maml:para>Stream with the file contents</maml:para> </maml:description> <command:parameterValue required="true">Stream</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The destination folder in the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Checkout</maml:name> <maml:description> <maml:para>If versioning is enabled, this will check out the file first if it exists, upload the file, then check it in again.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckInComment</maml:name> <maml:description> <maml:para>The comment added to the checkin.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Approve</maml:name> <maml:description> <maml:para>Will auto approve the uploaded file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ApproveComment</maml:name> <maml:description> <maml:para>The comment added to the approval.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Will auto publish the file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishComment</maml:name> <maml:description> <maml:para>The comment added to the publish action.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseWebDav</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names. Single line of text: -Values @{"Title" = "Title New"} Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} Choice: -Values @{"Choice" = "Value 1"} Number: -Values @{"Number" = "10"} Currency: -Values @{"Number" = "10"} Currency: -Values @{"Currency" = "10"} Date and Time: -Values @{"DateAndTime" = "03/10/2015 14:16"} Lookup (id of lookup value): -Values @{"Lookup" = "2"} Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} Yes/No: -Values @{"YesNo" = $false} Person/Group (id of user/group in Site User Info List or email of the user, separate multiple values with a comma): -Values @{"Person" = "user1@domain.com","21"} Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnp"}</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Use to assign a ContentType to the file.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Approve</maml:name> <maml:description> <maml:para>Will auto approve the uploaded file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ApproveComment</maml:name> <maml:description> <maml:para>The comment added to the approval.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckInComment</maml:name> <maml:description> <maml:para>The comment added to the checkin.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Checkout</maml:name> <maml:description> <maml:para>If versioning is enabled, this will check out the file first if it exists, upload the file, then check it in again.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Use to assign a ContentType to the file.</maml:para> </maml:description> <command:parameterValue required="false">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Name for file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The destination folder in the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NewFileName</maml:name> <maml:description> <maml:para>Filename to give the file on SharePoint</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>The local file path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Will auto publish the file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishComment</maml:name> <maml:description> <maml:para>The comment added to the publish action.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Stream</maml:name> <maml:description> <maml:para>Stream with the file contents</maml:para> </maml:description> <command:parameterValue required="true">Stream</command:parameterValue> <dev:type> <maml:name>Stream</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseWebDav</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names. Single line of text: -Values @{"Title" = "Title New"} Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} Choice: -Values @{"Choice" = "Value 1"} Number: -Values @{"Number" = "10"} Currency: -Values @{"Number" = "10"} Currency: -Values @{"Currency" = "10"} Date and Time: -Values @{"DateAndTime" = "03/10/2015 14:16"} Lookup (id of lookup value): -Values @{"Lookup" = "2"} Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} Yes/No: -Values @{"YesNo" = $false} Person/Group (id of user/group in Site User Info List or email of the user, separate multiple values with a comma): -Values @{"Person" = "user1@domain.com","21"} Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnp"}</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.File</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFile -Path c:\temp\company.master -Folder "_catalogs/masterpage"</dev:code> <maml:remarks> <maml:para>This will upload the file company.master to the masterpage catalog</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFile -Path .\displaytemplate.html -Folder "_catalogs/masterpage/display templates/test"</dev:code> <maml:remarks> <maml:para>This will upload the file displaytemplate.html to the test folder in the display templates folder. If the test folder does not exist it will create it.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFile -Path .\sample.doc -Folder "Shared Documents" -Values @{Modified="1/1/2016"}</dev:code> <maml:remarks> <maml:para>This will upload the file sample.doc to the Shared Documents folder. After uploading it will set the Modified date to 1/1/2016.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFile -FileName sample.doc -Folder "Shared Documents" -Stream $fileStream -Values @{Modified="1/1/2016"}</dev:code> <maml:remarks> <maml:para>This will add a file sample.doc with the contents of the stream into the Shared Documents folder. After adding it will set the Modified date to 1/1/2016.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFile -Path sample.doc -Folder "Shared Documents" -ContentType "Document" -Values @{Modified="1/1/2016"}</dev:code> <maml:remarks> <maml:para>This will add a file sample.doc to the Shared Documents folder, with a ContentType of 'Documents'. After adding it will set the Modified date to 1/1/2016.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFile -Path sample.docx -Folder "Documents" -Values @{Modified="1/1/2016"; Created="1/1/2017"; Editor=23}</dev:code> <maml:remarks> <maml:para>This will add a file sample.docx to the Documents folder and will set the Modified date to 1/1/2016, Created date to 1/1/2017 and the Modified By field to the user with ID 23. To find out about the proper user ID to relate to a specific user, use Get-PnPUser.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFile -Path sample.docx -Folder "Documents" -NewFileName "differentname.docx"</dev:code> <maml:remarks> <maml:para>This will upload a local file sample.docx to the Documents folder giving it the filename differentname.docx on SharePoint</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPFileToProvisioningTemplate</command:name> <maml:description> <maml:para>Adds a file to a PnP Provisioning Template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPFileToProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFileToProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filename of the .PNP Open XML site template to read from, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SourceUrl</maml:name> <maml:description> <maml:para>The file to add to the in-memory template, specifying its url in the current connected Web.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Container</maml:name> <maml:description> <maml:para>The target Container for the file to add to the in-memory template, optional argument.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>FileLevel</maml:name> <maml:description> <maml:para>The level of the files to add. Defaults to Published</maml:para> </maml:description> <command:parameterValue required="true">FileLevel</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while loading the template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>FileOverwrite</maml:name> <maml:description> <maml:para>Set to overwrite in site, Defaults to true</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPFileToProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filename of the .PNP Open XML site template to read from, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Source</maml:name> <maml:description> <maml:para>The file to add to the in-memory template, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The target Folder for the file to add to the in-memory template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Container</maml:name> <maml:description> <maml:para>The target Container for the file to add to the in-memory template, optional argument.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>FileLevel</maml:name> <maml:description> <maml:para>The level of the files to add. Defaults to Published</maml:para> </maml:description> <command:parameterValue required="true">FileLevel</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while loading the template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>FileOverwrite</maml:name> <maml:description> <maml:para>Set to overwrite in site, Defaults to true</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="3"> <maml:name>Container</maml:name> <maml:description> <maml:para>The target Container for the file to add to the in-memory template, optional argument.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>FileLevel</maml:name> <maml:description> <maml:para>The level of the files to add. Defaults to Published</maml:para> </maml:description> <command:parameterValue required="false">FileLevel</command:parameterValue> <dev:type> <maml:name>FileLevel</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>FileOverwrite</maml:name> <maml:description> <maml:para>Set to overwrite in site, Defaults to true</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The target Folder for the file to add to the in-memory template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filename of the .PNP Open XML site template to read from, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Source</maml:name> <maml:description> <maml:para>The file to add to the in-memory template, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SourceUrl</maml:name> <maml:description> <maml:para>The file to add to the in-memory template, specifying its url in the current connected Web.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while loading the template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFileToProvisioningTemplate -Path template.pnp -Source $sourceFilePath -Folder $targetFolder</dev:code> <maml:remarks> <maml:para>Adds a file to a PnP Site Template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFileToProvisioningTemplate -Path template.xml -Source $sourceFilePath -Folder $targetFolder</dev:code> <maml:remarks> <maml:para>Adds a file reference to a PnP Site XML Template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFileToProvisioningTemplate -Path template.pnp -Source "./myfile.png" -Folder "folderinsite" -FileLevel Published -FileOverwrite:$false</dev:code> <maml:remarks> <maml:para>Adds a file to a PnP Site Template, specifies the level as Published and defines to not overwrite the file if it exists in the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFileToProvisioningTemplate -Path template.pnp -Source $sourceFilePath -Folder $targetFolder -Container $container</dev:code> <maml:remarks> <maml:para>Adds a file to a PnP Site Template with a custom container for the file</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFileToProvisioningTemplate -Path template.pnp -SourceUrl "Shared%20Documents/ProjectStatus.docs"</dev:code> <maml:remarks> <maml:para>Adds a file to a PnP Provisioning Template retrieved from the currently connected site. The url can be server relative or web relative. If specifying a server relative url has to start with the current site url.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPFolder</command:name> <maml:description> <maml:para>Creates a folder within a parent folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPFolder</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The folder name</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The parent folder in the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The parent folder in the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The folder name</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPFolder -Name NewFolder -Folder _catalogs/masterpage</dev:code> <maml:remarks> <maml:para>This will create the folder NewFolder in the masterpage catalog</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPHtmlPublishingPageLayout</command:name> <maml:description> <maml:para>Adds a HTML based publishing page layout</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPHtmlPublishingPageLayout</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPHtmlPublishingPageLayout</maml:name> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the file which will be uploaded</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AssociatedContentTypeID</maml:name> <maml:description> <maml:para>Associated content type ID</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DestinationFolderHierarchy</maml:name> <maml:description> <maml:para>Folder hierarchy where the HTML page layouts will be deployed</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>AssociatedContentTypeID</maml:name> <maml:description> <maml:para>Associated content type ID</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DestinationFolderHierarchy</maml:name> <maml:description> <maml:para>Folder hierarchy where the HTML page layouts will be deployed</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the file which will be uploaded</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPHtmlPublishingPageLayout -Title 'Our custom page layout' -SourceFilePath 'customlayout.aspx' -Description 'A custom page layout' -AssociatedContentTypeID 0x01010901</dev:code> <maml:remarks> <maml:para>Uploads the pagelayout 'customlayout.aspx' from the current location to the current site as a 'web part page' pagelayout</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPHubSiteAssociation</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Connects a site to a hubsite.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPHubSiteAssociation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Connects an existing site to a hubsite</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPHubSiteAssociation</maml:name> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to connect to the hubsite</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>HubSite</maml:name> <maml:description> <maml:para>The hubsite to connect the site to</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>HubSite</maml:name> <maml:description> <maml:para>The hubsite to connect the site to</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> <dev:type> <maml:name>SitePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to connect to the hubsite</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> <dev:type> <maml:name>SitePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPHubSiteAssociation -Site https://tenant.sharepoint.com/sites/mysite -HubSite https://tenant.sharepoint.com/sites/hubsite</dev:code> <maml:remarks> <maml:para>This example adds the specified site to the hubsite.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPIndexedProperty</command:name> <maml:description> <maml:para>Marks the value of the propertybag key specified to be indexed by search.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPIndexedProperty</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPIndexedProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key of the property bag value to be indexed</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where to set the indexed property</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key of the property bag value to be indexed</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where to set the indexed property</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPJavaScriptBlock</command:name> <maml:description> <maml:para>Adds a link to a JavaScript snippet/block to a web or site collection</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPJavaScriptBlock</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Specify a scope as 'Site' to add the custom action to all sites in a site collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPJavaScriptBlock</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the script block. Can be used to identify the script with other cmdlets or coded solutions</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para>The javascript block to add to the specified scope</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>A sequence number that defines the order on the page</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the script to add to. Either Web or Site, defaults to Web. 'All' is not valid for this command.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the script block. Can be used to identify the script with other cmdlets or coded solutions</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the script to add to. Either Web or Site, defaults to Web. 'All' is not valid for this command.</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para>The javascript block to add to the specified scope</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>A sequence number that defines the order on the page</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPJavaScriptBlock -Name myAction -script '<script>Alert("This is my Script block");</script>' -Sequence 9999 -Scope Site</dev:code> <maml:remarks> <maml:para>Add a JavaScript code block to all pages within the current site collection under the name myAction and at order 9999</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPJavaScriptBlock -Name myAction -script '<script>Alert("This is my Script block");</script>'</dev:code> <maml:remarks> <maml:para>Add a JavaScript code block to all pages within the current web under the name myAction</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPJavaScriptLink</command:name> <maml:description> <maml:para>Adds a link to a JavaScript file to a web or sitecollection, valid only for SharePoint classic site experience.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPJavaScriptLink</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates a custom action that refers to a JavaScript file</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPJavaScriptLink</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name under which to register the JavaScriptLink</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>URL to the JavaScript file to inject</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this JavaScript being injected. Use when you have a specific sequence with which to have JavaScript files being added to the page. I.e. jQuery library first and then jQueryUI.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines if this JavaScript file will be injected to every page within the current site collection or web. All is not allowed in for this command. Default is web.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name under which to register the JavaScriptLink</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines if this JavaScript file will be injected to every page within the current site collection or web. All is not allowed in for this command. Default is web.</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this JavaScript being injected. Use when you have a specific sequence with which to have JavaScript files being added to the page. I.e. jQuery library first and then jQueryUI.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>URL to the JavaScript file to inject</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPJavaScriptLink -Name jQuery -Url https://code.jquery.com/jquery.min.js -Sequence 9999 -Scope Site</dev:code> <maml:remarks> <maml:para>Injects a reference to the latest v1 series jQuery library to all pages within the current site collection under the name jQuery and at order 9999</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPJavaScriptLink -Name jQuery -Url https://code.jquery.com/jquery.min.js</dev:code> <maml:remarks> <maml:para>Injects a reference to the latest v1 series jQuery library to all pages within the current web under the name jQuery</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPListFoldersToProvisioningTemplate</command:name> <maml:description> <maml:para>Adds folders to a list in a PnP Provisioning Template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPListFoldersToProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPListFoldersToProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filename of the .PNP Open XML site template to read from, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>A switch parameter to include all folders in the list, or just top level folders.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>IncludeSecurity</maml:name> <maml:description> <maml:para>A switch to include ObjectSecurity information.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while loading the template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="5"> <maml:name>IncludeSecurity</maml:name> <maml:description> <maml:para>A switch to include ObjectSecurity information.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filename of the .PNP Open XML site template to read from, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>A switch parameter to include all folders in the list, or just top level folders.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while loading the template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPListFoldersToProvisioningTemplate -Path template.pnp -List 'PnPTestList'</dev:code> <maml:remarks> <maml:para>Adds top level folders from a list to an existing template and returns an in-memory PnP Site Template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPListFoldersToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Recursive</dev:code> <maml:remarks> <maml:para>Adds all folders from a list to an existing template and returns an in-memory PnP Site Template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPListFoldersToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Recursive -IncludeSecurity</dev:code> <maml:remarks> <maml:para>Adds all folders from a list with unique permissions to an in-memory PnP Site Template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPListItem</command:name> <maml:description> <maml:para>Adds an item to the list and sets the creation time to the current date and time. The author is set to the current authenticated user executing the cmdlet. In order to set the author to a different user, please refer to Set-PnPListItem.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPListItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPListItem</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specify either the name, ID or an actual content type.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names. Single line of text: -Values @{"Title" = "Title New"} Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} Choice: -Values @{"Choice" = "Value 1"} Number: -Values @{"Number" = "10"} Currency: -Values @{"Number" = "10"} Currency: -Values @{"Currency" = "10"} Date and Time: -Values @{"DateAndTime" = "03/13/2015 14:16"} Lookup (id of lookup value): -Values @{"Lookup" = "2"} Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} Yes/No: -Values @{"YesNo" = $false} Person/Group (id of user/group in Site User Info List or email of the user, separate multiple values with a comma): -Values @{"Person" = "user1@domain.com","21"} Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnp"}</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The list relative URL of a folder. E.g. "MyFolder" for a folder located in the root of the list, or "MyFolder/SubFolder" for a folder located in the MyFolder folder which is located in the root of the list.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The name of the retention label.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specify either the name, ID or an actual content type.</maml:para> </maml:description> <command:parameterValue required="false">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The list relative URL of a folder. E.g. "MyFolder" for a folder located in the root of the list, or "MyFolder/SubFolder" for a folder located in the MyFolder folder which is located in the root of the list.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The name of the retention label.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names. Single line of text: -Values @{"Title" = "Title New"} Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"} Rich text: -Values @{"MultiText" = "<strong>New</strong> text"} Choice: -Values @{"Choice" = "Value 1"} Number: -Values @{"Number" = "10"} Currency: -Values @{"Number" = "10"} Currency: -Values @{"Currency" = "10"} Date and Time: -Values @{"DateAndTime" = "03/13/2015 14:16"} Lookup (id of lookup value): -Values @{"Lookup" = "2"} Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} Yes/No: -Values @{"YesNo" = $false} Person/Group (id of user/group in Site User Info List or email of the user, separate multiple values with a comma): -Values @{"Person" = "user1@domain.com","21"} Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnp"}</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.ListItem</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-PnPListItem -List "Demo List" -Values @{"Title" = "Test Title"; "Category"="Test Category"}</dev:code> <maml:remarks> <maml:para>Adds a new list item to the "Demo List", and sets both the Title and Category fields with the specified values. Notice, use the internal names of fields.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-PnPListItem -List "Demo List" -ContentType "Company" -Values @{"Title" = "Test Title"; "Category"="Test Category"}</dev:code> <maml:remarks> <maml:para>Adds a new list item to the "Demo List", sets the content type to "Company" and sets both the Title and Category fields with the specified values. Notice, use the internal names of fields.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-PnPListItem -List "Demo List" -Values @{"MultiUserField"="user1@domain.com","user2@domain.com"}</dev:code> <maml:remarks> <maml:para>Adds a new list item to the "Demo List" and sets the user field called MultiUserField to 2 users. Separate multiple users with a comma.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-PnPListItem -List "Demo List" -Values @{"Title"="Sales Report"} -Folder "projects/europe"</dev:code> <maml:remarks> <maml:para>Adds a new list item to the "Demo List". It will add the list item to the europe folder which is located in the projects folder. Folders will be created if needed.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-PnPListItem -List "Demo List" -Values @{"Title"="Sales Report"} -Label "Public"</dev:code> <maml:remarks> <maml:para>Adds a new list item to the "Demo List". Sets the retention label to "Public" if it exists on the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPMasterPage</command:name> <maml:description> <maml:para>Adds a Masterpage</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPMasterPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPMasterPage</maml:name> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the file which will be uploaded</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the Masterpage</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the Masterpage</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DestinationFolderHierarchy</maml:name> <maml:description> <maml:para>Folder hierarchy where the MasterPage will be deployed</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UIVersion</maml:name> <maml:description> <maml:para>UIVersion of the Masterpage. Default = 15</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultCssFile</maml:name> <maml:description> <maml:para>Default CSS file for the MasterPage, this Url is SiteRelative</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>DefaultCssFile</maml:name> <maml:description> <maml:para>Default CSS file for the MasterPage, this Url is SiteRelative</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the Masterpage</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DestinationFolderHierarchy</maml:name> <maml:description> <maml:para>Folder hierarchy where the MasterPage will be deployed</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the file which will be uploaded</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the Masterpage</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UIVersion</maml:name> <maml:description> <maml:para>UIVersion of the Masterpage. Default = 15</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.File</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPMasterPage -SourceFilePath "page.master" -Title "MasterPage" -Description "MasterPage for Web" -DestinationFolderHierarchy "SubFolder"</dev:code> <maml:remarks> <maml:para>Adds a MasterPage from the local file "page.master" to the folder "SubFolder" in the Masterpage gallery.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPNavigationNode</command:name> <maml:description> <maml:para>Adds an item to a navigation element</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPNavigationNode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds a menu item to either the quicklaunch or top navigation</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPNavigationNode</maml:name> <command:parameter required="true" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location of the node to add. Either TopNavigationBar, QuickLaunch, SearchNav</maml:para> </maml:description> <command:parameterValue required="true">NavigationType</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the node to add</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The url to navigate to when clicking the new menu item. This can either be absolute or relative to the Web. Fragments are not supported.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Parent</maml:name> <maml:description> <maml:para>The key of the parent. Leave empty to add to the top level</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Add the new menu item to beginning of the collection.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>External</maml:name> <maml:description> <maml:para>Indicates the destination URL is outside of the site collection.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>External</maml:name> <maml:description> <maml:para>Indicates the destination URL is outside of the site collection.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>First</maml:name> <maml:description> <maml:para>Add the new menu item to beginning of the collection.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location of the node to add. Either TopNavigationBar, QuickLaunch, SearchNav</maml:para> </maml:description> <command:parameterValue required="true">NavigationType</command:parameterValue> <dev:type> <maml:name>NavigationType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Parent</maml:name> <maml:description> <maml:para>The key of the parent. Leave empty to add to the top level</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the node to add</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The url to navigate to when clicking the new menu item. This can either be absolute or relative to the Web. Fragments are not supported.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.NavigationNode</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPNavigationNode -Title "Contoso" -Url "http://contoso.sharepoint.com/sites/contoso/" -Location "QuickLaunch"</dev:code> <maml:remarks> <maml:para>Adds a navigation node to the quicklaunch. The navigation node will have the title "Contoso" and will link to the url "http://contoso.sharepoint.com/sites/contoso/"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPNavigationNode -Title "Contoso USA" -Url "http://contoso.sharepoint.com/sites/contoso/usa/" -Location "QuickLaunch" -Parent 2012</dev:code> <maml:remarks> <maml:para>Adds a navigation node to the quicklaunch. The navigation node will have the title "Contoso USA", will link to the url "http://contoso.sharepoint.com/sites/contoso/usa/" and will have the node with id 2012 as a parent navigation node.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPNavigationNode -Title "Contoso" -Url "http://contoso.sharepoint.com/sites/contoso/" -Location "QuickLaunch" -First</dev:code> <maml:remarks> <maml:para>Adds a navigation node to the quicklaunch, as the first item. The navigation node will have the title "Contoso" and will link to the url "http://contoso.sharepoint.com/sites/contoso/"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPNavigationNode -Title "Contoso Pharmaceuticals" -Url "http://contoso.sharepoint.com/sites/contosopharma/" -Location "QuickLaunch" -External</dev:code> <maml:remarks> <maml:para>Adds a navigation node to the quicklaunch. The navigation node will have the title "Contoso Pharmaceuticals" and will link to the external url "http://contoso.sharepoint.com/sites/contosopharma/"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPNavigationNode -Title "Wiki" -Location "QuickLaunch" -Url "wiki/"</dev:code> <maml:remarks> <maml:para>Adds a navigation node to the quicklaunch. The navigation node will have the title "Wiki" and will link to Wiki library on the selected Web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-PnPOffice365GroupAliasIsUsed</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Tests if a given alias is already used used</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>PnPOffice365GroupAliasIsUsed</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command allows you to test if a provided alias is used or free, helps decide if it can be used as part of connecting an Office 365 Unified group to an existing classic site collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-PnPOffice365GroupAliasIsUsed</maml:name> <command:parameter required="true" position="named"> <maml:name>Alias</maml:name> <maml:description> <maml:para>Specifies the alias of the group. Cannot contain spaces.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Alias</maml:name> <maml:description> <maml:para>Specifies the alias of the group. Cannot contain spaces.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Test-PnPOffice365GroupAliasIsUsed -Alias "MyGroup"</dev:code> <maml:remarks> <maml:para>This will test if the alias MyGroup is already used</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPOffice365GroupToSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Groupifies a classic team site by creating an Office 365 group for it and connecting the site with the newly created group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPOffice365GroupToSite</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command allows you to add an Office 365 Unified group to an existing classic site collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPOffice365GroupToSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the site to be connected to an Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Alias</maml:name> <maml:description> <maml:para>Specifies the alias of the group. Cannot contain spaces.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The optional description of the group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Classification</maml:name> <maml:description> <maml:para>Specifies the classification of the group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsPublic</maml:name> <maml:description> <maml:para>Specifies if the group is public. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>KeepOldHomePage</maml:name> <maml:description> <maml:para>Specifies if the current site home page is kept. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HubSiteId</maml:name> <maml:description> <maml:para>If specified the site will be associated to the hubsite as identified by this id</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>The array UPN values of the group's owners.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Alias</maml:name> <maml:description> <maml:para>Specifies the alias of the group. Cannot contain spaces.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Classification</maml:name> <maml:description> <maml:para>Specifies the classification of the group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The optional description of the group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HubSiteId</maml:name> <maml:description> <maml:para>If specified the site will be associated to the hubsite as identified by this id</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsPublic</maml:name> <maml:description> <maml:para>Specifies if the group is public. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>KeepOldHomePage</maml:name> <maml:description> <maml:para>Specifies if the current site home page is kept. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>The array UPN values of the group's owners.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the site to be connected to an Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPOffice365GroupToSite -Url "https://contoso.sharepoint.com/sites/FinanceTeamsite" -Alias "FinanceTeamsite" -DisplayName = "My finance team site group"</dev:code> <maml:remarks> <maml:para>This will add a group called MyGroup to the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPOrgAssetsLibrary</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Adds a given document library as a organizational asset source</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPOrgAssetsLibrary</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds a given document library as an organizational asset source in your Sharepoint Online Tenant. All organizational asset sources you add must reside in the same site collection. Document libraries specified as organizational asset must be enabled as an Office 365 CDN source, either as private or public. It may take some time before this change will be reflected in the webinterface.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPOrgAssetsLibrary</maml:name> <command:parameter required="true" position="named"> <maml:name>LibraryUrl</maml:name> <maml:description> <maml:para>The full url of the document library to be marked as one of organization's assets sources</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>The full url to an image that should be used as a thumbnail for showing this source. The image must reside in the same site as the document library you specify.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>Indicates what type of Office 365 CDN source the document library will be added to</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>Indicates what type of Office 365 CDN source the document library will be added to</maml:para> </maml:description> <command:parameterValue required="false">SPOTenantCdnType</command:parameterValue> <dev:type> <maml:name>SPOTenantCdnType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>LibraryUrl</maml:name> <maml:description> <maml:para>The full url of the document library to be marked as one of organization's assets sources</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>The full url to an image that should be used as a thumbnail for showing this source. The image must reside in the same site as the document library you specify.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPOrgAssetsLibrary -LibraryUrl https://yourtenant.sharepoint.com/sites/branding/logos</dev:code> <maml:remarks> <maml:para>Adds the document library with the url "logos" located in the sitecollection at "https://yourtenant.sharepoint.com/sites/branding" as an organizational asset not specifying a thumbnail image for it and enabling the document library as a public Office 365 CDN source</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPOrgAssetsLibrary -LibraryUrl https://yourtenant.sharepoint.com/sites/branding/logos -ThumbnailUrl https://yourtenant.sharepoint.com/sites/branding/logos/thumbnail.jpg</dev:code> <maml:remarks> <maml:para>Adds the document library with the url "logos" located in the sitecollection at "https://yourtenant.sharepoint.com/sites/branding" as an organizational asset specifying the thumbnail image "thumbnail.jpg" residing in the same document library for it and enabling the document library as a public Office 365 CDN source</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPOrgAssetsLibrary -LibraryUrl https://yourtenant.sharepoint.com/sites/branding/logos -CdnType Private</dev:code> <maml:remarks> <maml:para>Adds the document library with the url "logos" located in the sitecollection at "https://yourtenant.sharepoint.com/sites/branding" as an organizational asset not specifying a thumbnail image for it and enabling the document library as a private Office 365 CDN source</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPOrgNewsSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Adds the site as an organization news source in your tenant</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPOrgNewsSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPOrgNewsSite</maml:name> <command:parameter required="true" position="named"> <maml:name>OrgNewsSiteUrl</maml:name> <maml:description> <maml:para>The url of the site to be marked as one of organization's news sites</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>OrgNewsSiteUrl</maml:name> <maml:description> <maml:para>The url of the site to be marked as one of organization's news sites</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> <dev:type> <maml:name>SitePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPOrgNewsSite -OrgNewsSiteUrl https://yourtenant.sharepoint.com/sites/news</dev:code> <maml:remarks> <maml:para>Adds the site as one of multiple possible tenant's organizational news sites</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPProvisioningTemplate</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Adds a PnP Provisioning Template object to a tenant template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>SiteTemplate</maml:name> <maml:description> <maml:para>The template to add to the tenant template</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningTemplate</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TenantTemplate</maml:name> <maml:description> <maml:para>The tenant template to add the template to</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningHierarchy</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>SiteTemplate</maml:name> <maml:description> <maml:para>The template to add to the tenant template</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningTemplate</command:parameterValue> <dev:type> <maml:name>ProvisioningTemplate</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TenantTemplate</maml:name> <maml:description> <maml:para>The tenant template to add the template to</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningHierarchy</command:parameterValue> <dev:type> <maml:name>ProvisioningHierarchy</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnpProvisioningTemplate -TenantTemplate $tenanttemplate -SiteTemplate $sitetemplate</dev:code> <maml:remarks> <maml:para>Adds an existing site template to an existing tenant template object</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPPublishingImageRendition</command:name> <maml:description> <maml:para>Adds an Image Rendition if the Name of the Image Rendition does not already exist. This prevents creating two Image Renditions that share the same name.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPPublishingImageRendition</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPublishingImageRendition</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The display name of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Width</maml:name> <maml:description> <maml:para>The width of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Height</maml:name> <maml:description> <maml:para>The height of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Height</maml:name> <maml:description> <maml:para>The height of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The display name of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Width</maml:name> <maml:description> <maml:para>The width of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPPublishingImageRendition -Name "MyImageRendition" -Width 800 -Height 600</dev:code> <maml:remarks> <maml:para /> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPPublishingPage</command:name> <maml:description> <maml:para>Adds a publishing page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPPublishingPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPublishingPage</maml:name> <command:parameter required="true" position="named"> <maml:name>PageName</maml:name> <maml:description> <maml:para>The name of the page to be added as an aspx file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PageTemplateName</maml:name> <maml:description> <maml:para>The name of the page layout you want to use. Specify without the .aspx extension. So 'ArticleLeft' or 'BlankWebPartPage'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the page</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>The site relative folder path of the page to be added</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Publishes the page. Also Approves it if moderation is enabled on the Pages library.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>The site relative folder path of the page to be added</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PageName</maml:name> <maml:description> <maml:para>The name of the page to be added as an aspx file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PageTemplateName</maml:name> <maml:description> <maml:para>The name of the page layout you want to use. Specify without the .aspx extension. So 'ArticleLeft' or 'BlankWebPartPage'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Publishes the page. Also Approves it if moderation is enabled on the Pages library.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the page</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPPublishingPage -PageName 'OurNewPage' -Title 'Our new page' -PageTemplateName 'ArticleLeft'</dev:code> <maml:remarks> <maml:para>Creates a new page based on the pagelayout 'ArticleLeft'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPPublishingPage -PageName 'OurNewPage' -Title 'Our new page' -PageTemplateName 'ArticleLeft' -Folder '/Pages/folder'</dev:code> <maml:remarks> <maml:para>Creates a new page based on the pagelayout 'ArticleLeft' with a site relative folder path</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPPublishingPageLayout</command:name> <maml:description> <maml:para>Adds a publishing page layout</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPPublishingPageLayout</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPublishingPageLayout</maml:name> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the file which will be uploaded</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AssociatedContentTypeID</maml:name> <maml:description> <maml:para>Associated content type ID</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DestinationFolderHierarchy</maml:name> <maml:description> <maml:para>Folder hierarchy where the html page layouts will be deployed</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>AssociatedContentTypeID</maml:name> <maml:description> <maml:para>Associated content type ID</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DestinationFolderHierarchy</maml:name> <maml:description> <maml:para>Folder hierarchy where the html page layouts will be deployed</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the file which will be uploaded</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPPublishingPageLayout -Title 'Our custom page layout' -SourceFilePath 'customlayout.aspx' -Description 'A custom page layout' -AssociatedContentTypeID 0x01010901</dev:code> <maml:remarks> <maml:para>Uploads the pagelayout 'customlayout.aspx' to the current site as a 'web part page' pagelayout</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPRoleDefinition</command:name> <maml:description> <maml:para>Adds a Role Defintion (Permission Level) to the site collection in the current context</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPRoleDefinition</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command allows adding a custom Role Defintion (Permission Level) to the site collection in the current context. It does not replace or remove existing Role Definitions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPRoleDefinition</maml:name> <command:parameter required="true" position="named"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Name of new permission level.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Clone</maml:name> <maml:description> <maml:para>An existing permission level or the name of an permission level to clone as base template.</maml:para> </maml:description> <command:parameterValue required="true">RoleDefinitionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Include</maml:name> <maml:description> <maml:para>Specifies permission flags(s) to enable. Please visit https://docs.microsoft.com/previous-versions/office/sharepoint-csom/ee536458(v%3Doffice.15) for the PermissionKind enum</maml:para> </maml:description> <command:parameterValue required="true">PermissionKind[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Exclude</maml:name> <maml:description> <maml:para>Specifies permission flags(s) to disable. Please visit https://docs.microsoft.com/previous-versions/office/sharepoint-csom/ee536458(v%3Doffice.15) for the PermissionKind enum</maml:para> </maml:description> <command:parameterValue required="true">PermissionKind[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description for the new permission level.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Clone</maml:name> <maml:description> <maml:para>An existing permission level or the name of an permission level to clone as base template.</maml:para> </maml:description> <command:parameterValue required="false">RoleDefinitionPipeBind</command:parameterValue> <dev:type> <maml:name>RoleDefinitionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description for the new permission level.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Exclude</maml:name> <maml:description> <maml:para>Specifies permission flags(s) to disable. Please visit https://docs.microsoft.com/previous-versions/office/sharepoint-csom/ee536458(v%3Doffice.15) for the PermissionKind enum</maml:para> </maml:description> <command:parameterValue required="false">PermissionKind[]</command:parameterValue> <dev:type> <maml:name>PermissionKind[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Include</maml:name> <maml:description> <maml:para>Specifies permission flags(s) to enable. Please visit https://docs.microsoft.com/previous-versions/office/sharepoint-csom/ee536458(v%3Doffice.15) for the PermissionKind enum</maml:para> </maml:description> <command:parameterValue required="false">PermissionKind[]</command:parameterValue> <dev:type> <maml:name>PermissionKind[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Name of new permission level.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPRoleDefinition -RoleName "CustomPerm"</dev:code> <maml:remarks> <maml:para>Creates additional permission level with no permission flags enabled.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPRoleDefinition -RoleName "NoDelete" -Clone "Contribute" -Exclude DeleteListItems</dev:code> <maml:remarks> <maml:para>Creates additional permission level by cloning "Contribute" and removes flags DeleteListItems</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPRoleDefinition -RoleName "AddOnly" -Clone "Contribute" -Exclude DeleteListItems, EditListItems</dev:code> <maml:remarks> <maml:para>Creates additional permission level by cloning "Contribute" and removes flags DeleteListItems and EditListItems</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $roleDefinition = Get-PnPRoleDefinition -Identity "Contribute" PS:> Add-PnPRoleDefinition -RoleName "AddOnly" -Clone $roleDefinition -Exclude DeleteListItems, EditListItems</dev:code> <maml:remarks> <maml:para>Creates additional permission level by cloning "Contribute" and removes flags DeleteListItems and EditListItems</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPSiteClassification</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Adds one ore more site classification values to the list of possible values. Requires a connection to the Microsoft Graph.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPSiteClassification</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteClassification</maml:name> <command:parameter required="true" position="named"> <maml:name>Classifications</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Classifications</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" PS:> Add-PnPSiteClassification -Classifications "Top Secret"</dev:code> <maml:remarks> <maml:para>Adds the "Top Secret" classification to the already existing classification values.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" PS:> Add-PnPSiteClassification -Classifications "Top Secret","HBI"</dev:code> <maml:remarks> <maml:para>Adds the "Top Secret" and the "For Your Eyes Only" classification to the already existing classification values.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPSiteCollectionAdmin</command:name> <maml:description> <maml:para>Adds one or more users as site collection administrators to the site collection in the current context</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPSiteCollectionAdmin</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command allows adding one to many users as site collection administrators to the site collection in the current context. It does not replace or remove existing site collection administrators.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteCollectionAdmin</maml:name> <command:parameter required="true" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies owner(s) to add as site collection administrators. They will be added as additional site collection administrators to the site in the current context. Existing administrators will stay. Can be both users and groups.</maml:para> </maml:description> <command:parameterValue required="true">UserPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies owner(s) to add as site collection administrators. They will be added as additional site collection administrators to the site in the current context. Existing administrators will stay. Can be both users and groups.</maml:para> </maml:description> <command:parameterValue required="true">UserPipeBind</command:parameterValue> <dev:type> <maml:name>UserPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPSiteCollectionAdmin -Owners "user@contoso.onmicrosoft.com"</dev:code> <maml:remarks> <maml:para>This will add user@contoso.onmicrosoft.com as an additional site collection owner to the site collection in the current context</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPSiteCollectionAdmin -Owners @("user1@contoso.onmicrosoft.com", "user2@contoso.onmicrosoft.com")</dev:code> <maml:remarks> <maml:para>This will add user1@contoso.onmicrosoft.com and user2@contoso.onmicrosoft.com as additional site collection owners to the site collection in the current context</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUser | ? Title -Like "*Doe" | Add-PnPSiteCollectionAdmin</dev:code> <maml:remarks> <maml:para>This will add all users with their title ending with "Doe" as additional site collection owners to the site collection in the current context</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPSiteCollectionAppCatalog</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Adds a Site Collection scoped App Catalog to a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPSiteCollectionAppCatalog</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteCollectionAppCatalog</maml:name> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>Url of the site to add the app catalog to.</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>Url of the site to add the app catalog to.</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> <dev:type> <maml:name>SitePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPSiteCollectionAppCatalog -Site "https://contoso.sharepoint.com/sites/FinanceTeamsite"</dev:code> <maml:remarks> <maml:para>This will add a SiteCollection app catalog to the specified site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPSiteDesign</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Creates a new Site Design on the current tenant.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPSiteDesign</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteDesign</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site design</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SiteScriptIds</maml:name> <maml:description> <maml:para>An array of guids of site scripts</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>WebTemplate</maml:name> <maml:description> <maml:para>Specifies the type of site to which this design applies</maml:para> </maml:description> <command:parameterValue required="true">SiteWebTemplate</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site design</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Specifies if the site design is a default site design</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PreviewImageAltText</maml:name> <maml:description> <maml:para>Sets the text for the preview image</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PreviewImageUrl</maml:name> <maml:description> <maml:para>Sets the url to the preview image</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site design</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Specifies if the site design is a default site design</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PreviewImageAltText</maml:name> <maml:description> <maml:para>Sets the text for the preview image</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PreviewImageUrl</maml:name> <maml:description> <maml:para>Sets the url to the preview image</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SiteScriptIds</maml:name> <maml:description> <maml:para>An array of guids of site scripts</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind[]</command:parameterValue> <dev:type> <maml:name>GuidPipeBind[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site design</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>WebTemplate</maml:name> <maml:description> <maml:para>Specifies the type of site to which this design applies</maml:para> </maml:description> <command:parameterValue required="true">SiteWebTemplate</command:parameterValue> <dev:type> <maml:name>SiteWebTemplate</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPSiteDesign -Title "My Company Design" -SiteScriptIds "e84dcb46-3ab9-4456-a136-66fc6ae3d3c5","6def687f-0e08-4f1e-999c-791f3af9a600" -Description "My description" -WebTemplate TeamSite</dev:code> <maml:remarks> <maml:para>Adds a new Site Design, with the specified title and description. When applied it will run the scripts as referenced by the IDs. Use Get-PnPSiteScript to receive Site Scripts. The WebTemplate parameter specifies that this design applies to Team Sites.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPSiteDesignTask</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. This command is used to apply a published site design to a specified site collection target. It schedules the operation, allowing for the application of larger site scripts (Invoke-PnPSiteDesign is limited to 30 actions and subactions). This command is intended to replace Invoke-PnPSiteDesign and is useful when you need to apply a large number of actions or multiple site scripts.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPSiteDesignTask</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteDesignTask</maml:name> <command:parameter required="true" position="named"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para>The ID of the site design to apply.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the site collection where the site design will be applied. If not specified the design will be applied to the site you connected to with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para>The ID of the site design to apply.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the site collection where the site design will be applied. If not specified the design will be applied to the site you connected to with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPSiteDesignTask -SiteDesignId 501z8c32-4147-44d4-8607-26c2f67cae82</dev:code> <maml:remarks> <maml:para>This example applies a site design the currently connected to site. Executing the commands will schedule the site design to be queued and run against the designated site collection.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPSiteDesignTask -SiteDesignId 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/project"</dev:code> <maml:remarks> <maml:para>This example applies a site design to the designated site. Executing the commands will schedule the site design to be queued and run against the designated site collection.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPSiteScript</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Creates a new Site Script on the current tenant.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPSiteScript</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteScript</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site script</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para>A JSON string containing the site script</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site script</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para>A JSON string containing the site script</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site script</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site script</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPSiteScript -Title "My Site Script" -Description "A more detailed description" -Content $script</dev:code> <maml:remarks> <maml:para>Adds a new Site Script, where $script variable contains the script.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPStoredCredential</command:name> <maml:description> <maml:para>Adds a credential to the Windows Credential Manager</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPStoredCredential</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds an entry to the Windows Credential Manager. If you add an entry in the form of the URL of your tenant/server PnP PowerShell will check if that entry is available when you connect using Connect-PnPOnline. If it finds a matching URL it will use the associated credentials. If you add a Credential with a name of "https://yourtenant.sharepoint.com" it will find a match when you connect to "https://yourtenant.sharepoint.com" but also when you connect to "https://yourtenant.sharepoint.com/sites/demo1". Of course you can specify more granular entries, allow you to automatically provide credentials for different URLs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPStoredCredential</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The credential to set</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Username</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>If not specified you will be prompted to enter your password. If you want to specify this value use ConvertTo-SecureString -String 'YourPassword' -AsPlainText -Force</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The credential to set</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>If not specified you will be prompted to enter your password. If you want to specify this value use ConvertTo-SecureString -String 'YourPassword' -AsPlainText -Force</maml:para> </maml:description> <command:parameterValue required="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Username</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPStoredCredential -Name https://tenant.sharepoint.com -Username yourname@tenant.onmicrosoft.com</dev:code> <maml:remarks> <maml:para>You will be prompted to specify the password and a new entry will be added with the specified values</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPStoredCredential -Name https://tenant.sharepoint.com -Username yourname@tenant.onmicrosoft.com -Password (ConvertTo-SecureString -String "YourPassword" -AsPlainText -Force)</dev:code> <maml:remarks> <maml:para>A new entry will be added with the specified values</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPStoredCredential -Name https://tenant.sharepoint.com -Username yourname@tenant.onmicrosoft.com -Password (ConvertTo-SecureString -String "YourPassword" -AsPlainText -Force) Connect-PnPOnline -Url https://tenant.sharepoint.com/sites/mydemosite</dev:code> <maml:remarks> <maml:para>A new entry will be added with the specified values, and a subsequent connection to a sitecollection starting with the entry name will be made. Notice that no password prompt will occur.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPTaxonomyField</command:name> <maml:description> <maml:para>Add a taxonomy field</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPTaxonomyField</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds a taxonomy/managed metadata field to a list or as a site column.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTaxonomyField</maml:name> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TaxonomyItemId</maml:name> <maml:description> <maml:para>The ID of the Taxonomy item</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where this field needs to be added</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group name to where this field belongs to</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID for the field, must be unique</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Switch Parameter if this field must be added to the default view</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MultiValue</maml:name> <maml:description> <maml:para>Switch Parameter if this Taxonomy field can hold multiple values</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para>Switch Parameter if the field is a required field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FieldOptions</maml:name> <maml:description> <maml:para>Specifies the control settings while adding a field. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx for details</maml:para> </maml:description> <command:parameterValue required="true">AddFieldOptions</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPTaxonomyField</maml:name> <command:parameter required="true" position="named"> <maml:name>TermSetPath</maml:name> <maml:description> <maml:para>The path to the term that this needs to be bound</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermPathDelimiter</maml:name> <maml:description> <maml:para>The path delimiter to be used, by default this is '|'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where this field needs to be added</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group name to where this field belongs to</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID for the field, must be unique</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Switch Parameter if this field must be added to the default view</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MultiValue</maml:name> <maml:description> <maml:para>Switch Parameter if this Taxonomy field can hold multiple values</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para>Switch Parameter if the field is a required field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FieldOptions</maml:name> <maml:description> <maml:para>Specifies the control settings while adding a field. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx for details</maml:para> </maml:description> <command:parameterValue required="true">AddFieldOptions</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AddToDefaultView</maml:name> <maml:description> <maml:para>Switch Parameter if this field must be added to the default view</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FieldOptions</maml:name> <maml:description> <maml:para>Specifies the control settings while adding a field. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx for details</maml:para> </maml:description> <command:parameterValue required="false">AddFieldOptions</command:parameterValue> <dev:type> <maml:name>AddFieldOptions</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group name to where this field belongs to</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID for the field, must be unique</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where this field needs to be added</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MultiValue</maml:name> <maml:description> <maml:para>Switch Parameter if this Taxonomy field can hold multiple values</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Required</maml:name> <maml:description> <maml:para>Switch Parameter if the field is a required field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TaxonomyItemId</maml:name> <maml:description> <maml:para>The ID of the Taxonomy item</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermPathDelimiter</maml:name> <maml:description> <maml:para>The path delimiter to be used, by default this is '|'</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermSetPath</maml:name> <maml:description> <maml:para>The path to the term that this needs to be bound</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Field</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPTaxonomyField -DisplayName "Test" -InternalName "Test" -TermSetPath "TestTermGroup|TestTermSet"</dev:code> <maml:remarks> <maml:para>Adds a new taxonomy field called "Test" that points to the TestTermSet which is located in the TestTermGroup</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPTeamsTeam</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Adds a Teams team to an existing, group connected, site collection</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPTeamsTeam</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command allows you to add a Teams team to an existing, Office 365 group connected, site collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTeamsTeam</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPTeamsTeam</dev:code> <maml:remarks> <maml:para>This create a teams team for the connected site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPTenantCdnOrigin</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Adds a new origin to the public or private content delivery network (CDN).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPTenantCdnOrigin</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Add a new origin to the public or private CDN, on either Tenant level or on a single Site level. Effectively, a tenant admin points out to a document library, or a folder in the document library and requests that content in that library should be retrievable by using a CDN. You must be a SharePoint Online global administrator and a site collection administrator to run the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTenantCdnOrigin</maml:name> <command:parameter required="true" position="named"> <maml:name>OriginUrl</maml:name> <maml:description> <maml:para>Specifies a path to the doc library to be configured. It can be provided in two ways: relative path, or a mask. Relative-Relative path depends on the OriginScope. If the originScope is Tenant, a path must be a relative path under the tenant root. If the originScope is Site, a path must be a relative path under the given Site. The path must point to the valid Document Library or a folder with a document library.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>Specifies the CDN type. The valid values are: public or private.</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>Specifies the CDN type. The valid values are: public or private.</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> <dev:type> <maml:name>SPOTenantCdnType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>OriginUrl</maml:name> <maml:description> <maml:para>Specifies a path to the doc library to be configured. It can be provided in two ways: relative path, or a mask. Relative-Relative path depends on the OriginScope. If the originScope is Tenant, a path must be a relative path under the tenant root. If the originScope is Site, a path must be a relative path under the given Site. The path must point to the valid Document Library or a folder with a document library.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPTenantCdnOrigin -OriginUrl /sites/site/subfolder -CdnType Public</dev:code> <maml:remarks> <maml:para>This example configures a public CDN on site level.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPTenantSequence</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Adds a tenant sequence object to a tenant template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPTenantSequence</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTenantSequence</maml:name> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The template to add the sequence to</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningHierarchy</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Optional Id of the sequence</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningSequence</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Optional Id of the sequence</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningSequence</command:parameterValue> <dev:type> <maml:name>ProvisioningSequence</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The template to add the sequence to</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningHierarchy</command:parameterValue> <dev:type> <maml:name>ProvisioningHierarchy</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPTenantSequence -Template $mytemplate -Sequence $mysequence</dev:code> <maml:remarks> <maml:para>Adds an existing sequence object to an existing template object</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPTenantSequence -Id "MySequence" | Add-PnPTenantSequence -Template $template</dev:code> <maml:remarks> <maml:para>Creates a new instance of a provisioning sequence object and sets the Id to the value specified, then the sequence is added to an existing template object</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPTenantSequenceSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Adds a existing tenant sequence site object to a tenant template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPTenantSequenceSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTenantSequenceSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ProvisioningSitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>The sequence to add the site to</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningSequence</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>The sequence to add the site to</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningSequence</command:parameterValue> <dev:type> <maml:name>ProvisioningSequence</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ProvisioningSitePipeBind</command:parameterValue> <dev:type> <maml:name>ProvisioningSitePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPTenantSequenceSite -Site $myteamsite -Sequence $mysequence</dev:code> <maml:remarks> <maml:para>Adds an existing site object to an existing template sequence</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPTenantSequenceSubSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Adds a tenant sequence sub site object to a tenant sequence site object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPTenantSequenceSubSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTenantSequenceSubSite</maml:name> <command:parameter required="true" position="named"> <maml:name>SubSite</maml:name> <maml:description> <maml:para>The subsite to add</maml:para> </maml:description> <command:parameterValue required="true">TeamNoGroupSubSite</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to add the subsite to</maml:para> </maml:description> <command:parameterValue required="true">SiteCollection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to add the subsite to</maml:para> </maml:description> <command:parameterValue required="true">SiteCollection</command:parameterValue> <dev:type> <maml:name>SiteCollection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SubSite</maml:name> <maml:description> <maml:para>The subsite to add</maml:para> </maml:description> <command:parameterValue required="true">TeamNoGroupSubSite</command:parameterValue> <dev:type> <maml:name>TeamNoGroupSubSite</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPTenantSequenceSubSite -Site $mysite -SubSite $mysubsite</dev:code> <maml:remarks> <maml:para>Adds an existing subsite object to an existing sequence site object</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPTenantTheme</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Adds or updates a theme to the tenant.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPTenantTheme</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds or updates a theme to the tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTenantTheme</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the theme to add or update</maml:para> </maml:description> <command:parameterValue required="true">ThemePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Palette</maml:name> <maml:description> <maml:para>The palette to add. See examples for more information.</maml:para> </maml:description> <command:parameterValue required="true">ThemePalettePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>IsInverted</maml:name> <maml:description> <maml:para>If the theme is inverted or not</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the theme to add or update</maml:para> </maml:description> <command:parameterValue required="true">ThemePipeBind</command:parameterValue> <dev:type> <maml:name>ThemePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>IsInverted</maml:name> <maml:description> <maml:para>If the theme is inverted or not</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Palette</maml:name> <maml:description> <maml:para>The palette to add. See examples for more information.</maml:para> </maml:description> <command:parameterValue required="true">ThemePalettePipeBind</command:parameterValue> <dev:type> <maml:name>ThemePalettePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $themepalette = @{ "themePrimary" = "#00ffff"; "themeLighterAlt" = "#f3fcfc"; "themeLighter" = "#daffff"; "themeLight" = "#affefe"; "themeTertiary" = "#76ffff"; "themeSecondary" = "#39ffff"; "themeDarkAlt" = "#00c4c4"; "themeDark" = "#009090"; "themeDarker" = "#005252"; "neutralLighterAlt" = "#f8f8f8"; "neutralLighter" = "#f4f4f4"; "neutralLight" = "#eaeaea"; "neutralQuaternaryAlt" = "#dadada"; "neutralQuaternary" = "#d0d0d0"; "neutralTertiaryAlt" = "#c8c8c8"; "neutralTertiary" = "#a6a6a6"; "neutralSecondaryAlt" = "#767676"; "neutralSecondary" = "#666666"; "neutralPrimary" = "#333"; "neutralPrimaryAlt" = "#3c3c3c"; "neutralDark" = "#212121"; "black" = "#000000"; "white" = "#fff"; "primaryBackground" = "#fff"; "primaryText" = "#333" } PS:>Add-PnPTenantTheme -Identity "MyCompanyTheme" -Palette $themepalette -IsInverted $false</dev:code> <maml:remarks> <maml:para>This example adds a theme to the current tenant.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPUserToGroup</command:name> <maml:description> <maml:para>Adds a user to a group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPUserToGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPUserToGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>The login name of the user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The group id, group name or group object to add the user to.</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPUserToGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The group id, group name or group object to add the user to.</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>The email address of the user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SendEmail</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EmailBody</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>The email address of the user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EmailBody</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The group id, group name or group object to add the user to.</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>The login name of the user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SendEmail</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPUserToGroup -LoginName user@company.com -Identity 'Marketing Site Members'</dev:code> <maml:remarks> <maml:para>Add the specified user to the group "Marketing Site Members"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPUserToGroup -LoginName user@company.com -Identity 5</dev:code> <maml:remarks> <maml:para>Add the specified user to the group with Id 5</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPView</command:name> <maml:description> <maml:para>Adds a view to a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPView</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPView</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the view.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A list of fields to add.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>A valid CAML Query.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ViewType</maml:name> <maml:description> <maml:para>The type of view to add.</maml:para> </maml:description> <command:parameterValue required="true">ViewType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>The row limit for the view. Defaults to 30.</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Personal</maml:name> <maml:description> <maml:para>If specified, a personal view will be created.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetAsDefault</maml:name> <maml:description> <maml:para>If specified, the view will be set as the default view for the list.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Paged</maml:name> <maml:description> <maml:para>If specified, the view will have paging.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Aggregations</maml:name> <maml:description> <maml:para>A valid XML fragment containing one or more Aggregations</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Aggregations</maml:name> <maml:description> <maml:para>A valid XML fragment containing one or more Aggregations</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A list of fields to add.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Paged</maml:name> <maml:description> <maml:para>If specified, the view will have paging.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Personal</maml:name> <maml:description> <maml:para>If specified, a personal view will be created.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>A valid CAML Query.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>The row limit for the view. Defaults to 30.</maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetAsDefault</maml:name> <maml:description> <maml:para>If specified, the view will be set as the default view for the list.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the view.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ViewType</maml:name> <maml:description> <maml:para>The type of view to add.</maml:para> </maml:description> <command:parameterValue required="false">ViewType</command:parameterValue> <dev:type> <maml:name>ViewType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.View</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-PnPView -List "Demo List" -Title "Demo View" -Fields "Title","Address"</dev:code> <maml:remarks> <maml:para>Adds a view named "Demo view" to the "Demo List" list.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-PnPView -List "Demo List" -Title "Demo View" -Fields "Title","Address" -Paged</dev:code> <maml:remarks> <maml:para>Adds a view named "Demo view" to the "Demo List" list and makes sure there's paging on this view.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-PnPView -List "Demo List" -Title "Demo View" -Fields "Title","Address" -Aggregations "<FieldRef Name='Title' Type='COUNT'/>"</dev:code> <maml:remarks> <maml:para>Adds a view named "Demo view" to the "Demo List" list and sets the totals (aggregations) to Count on the Title field.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPWebhookSubscription</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Adds a new Webhook subscription</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPWebhookSubscription</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPWebhookSubscription</maml:name> <command:parameter required="true" position="named"> <maml:name>NotificationUrl</maml:name> <maml:description> <maml:para>The URL of the Webhook endpoint that will be notified of the change</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where the Webhook subscription will be added to</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExpirationDate</maml:name> <maml:description> <maml:para>The date at which the Webhook subscription will expire. (Default: 6 months from today)</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientState</maml:name> <maml:description> <maml:para>A client state information that will be passed through notifications</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ClientState</maml:name> <maml:description> <maml:para>A client state information that will be passed through notifications</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExpirationDate</maml:name> <maml:description> <maml:para>The date at which the Webhook subscription will expire. (Default: 6 months from today)</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where the Webhook subscription will be added to</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>NotificationUrl</maml:name> <maml:description> <maml:para>The URL of the Webhook endpoint that will be notified of the change</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OfficeDevPnP.Core.Entities.WebhookSubscription</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook</dev:code> <maml:remarks> <maml:para>Add a Webhook subscription for the specified notification Url on the list MyList</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook -ExpirationDate "2017-09-01"</dev:code> <maml:remarks> <maml:para>Add a Webhook subscription for the specified notification Url on the list MyList with an expiration date set on September 1st, 2017</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook -ExpirationDate "2017-09-01" -ClientState "Hello State!"</dev:code> <maml:remarks> <maml:para>Add a Webhook subscription for the specified notification Url on the list MyList with an expiration date set on September 1st, 2017 with a specific client state</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPWebPartToWebPartPage</command:name> <maml:description> <maml:para>Adds a web part to a web part page in a specified zone</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPWebPartToWebPartPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPWebPartToWebPartPage</maml:name> <command:parameter required="true" position="named"> <maml:name>Xml</maml:name> <maml:description> <maml:para>A string containing the XML for the web part.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Server Relative Url of the page to add the web part to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ZoneId</maml:name> <maml:description> <maml:para>The Zone Id where the web part must be placed</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ZoneIndex</maml:name> <maml:description> <maml:para>The Zone Index where the web part must be placed</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPWebPartToWebPartPage</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>A path to a web part file on a the file system.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Server Relative Url of the page to add the web part to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ZoneId</maml:name> <maml:description> <maml:para>The Zone Id where the web part must be placed</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ZoneIndex</maml:name> <maml:description> <maml:para>The Zone Index where the web part must be placed</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>A path to a web part file on a the file system.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Server Relative Url of the page to add the web part to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Xml</maml:name> <maml:description> <maml:para>A string containing the XML for the web part.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ZoneId</maml:name> <maml:description> <maml:para>The Zone Id where the web part must be placed</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ZoneIndex</maml:name> <maml:description> <maml:para>The Zone Index where the web part must be placed</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Path "c:\myfiles\listview.webpart" -ZoneId "Header" -ZoneIndex 1 </dev:code> <maml:remarks> <maml:para>This will add the web part as defined by the XML in the listview.webpart file to the specified page in the specified zone and with the order index of 1</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -XML $webpart -ZoneId "Header" -ZoneIndex 1 </dev:code> <maml:remarks> <maml:para>This will add the web part as defined by the XML in the $webpart variable to the specified page in the specified zone and with the order index of 1</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPWebPartToWikiPage</command:name> <maml:description> <maml:para>Adds a web part to a wiki page in a specified table row and column</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPWebPartToWikiPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPWebPartToWikiPage</maml:name> <command:parameter required="true" position="named"> <maml:name>Xml</maml:name> <maml:description> <maml:para>A string containing the XML for the web part.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the web part page, e.g. /sites/demo/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Row</maml:name> <maml:description> <maml:para>Row number where the web part must be placed</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para>Column number where the web part must be placed</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddSpace</maml:name> <maml:description> <maml:para>Must there be a extra space between the web part</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPWebPartToWikiPage</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>A path to a web part file on a the file system.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the web part page, e.g. /sites/demo/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Row</maml:name> <maml:description> <maml:para>Row number where the web part must be placed</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para>Column number where the web part must be placed</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddSpace</maml:name> <maml:description> <maml:para>Must there be a extra space between the web part</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AddSpace</maml:name> <maml:description> <maml:para>Must there be a extra space between the web part</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para>Column number where the web part must be placed</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>A path to a web part file on a the file system.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Row</maml:name> <maml:description> <maml:para>Row number where the web part must be placed</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the web part page, e.g. /sites/demo/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Xml</maml:name> <maml:description> <maml:para>A string containing the XML for the web part.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPWebPartToWikiPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Path "c:\myfiles\listview.webpart" -Row 1 -Column 1</dev:code> <maml:remarks> <maml:para>This will add the web part as defined by the XML in the listview.webpart file to the specified page in the first row and the first column of the HTML table present on the page</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPWebPartToWikiPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -XML $webpart -Row 1 -Column 1</dev:code> <maml:remarks> <maml:para>This will add the web part as defined by the XML in the $webpart variable to the specified page in the first row and the first column of the HTML table present on the page</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPWikiPage</command:name> <maml:description> <maml:para>Adds a wiki page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPWikiPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPWikiPage</maml:name> <command:parameter required="true" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>The server relative page URL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPWikiPage</maml:name> <command:parameter required="true" position="named"> <maml:name>Layout</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">WikiPageLayout</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>The server relative page URL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Layout</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">WikiPageLayout</command:parameterValue> <dev:type> <maml:name>WikiPageLayout</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>The server relative page URL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPWikiPage -PageUrl '/sites/demo1/pages/wikipage.aspx' -Content 'New WikiPage'</dev:code> <maml:remarks> <maml:para>Creates a new wiki page '/sites/demo1/pages/wikipage.aspx' and sets the content to 'New WikiPage'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPWorkflowDefinition</command:name> <maml:description> <maml:para>Adds a workflow definition</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPWorkflowDefinition</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPWorkflowDefinition</maml:name> <command:parameter required="true" position="named"> <maml:name>Definition</maml:name> <maml:description> <maml:para>The workflow definition to add.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowDefinition</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DoNotPublish</maml:name> <maml:description> <maml:para>Overrides the default behavior, which is to publish workflow definitions.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Definition</maml:name> <maml:description> <maml:para>The workflow definition to add.</maml:para> </maml:description> <command:parameterValue required="true">WorkflowDefinition</command:parameterValue> <dev:type> <maml:name>WorkflowDefinition</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DoNotPublish</maml:name> <maml:description> <maml:para>Overrides the default behavior, which is to publish workflow definitions.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> <maml:description> <maml:para>Returns the Id of the workflow definition</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPWorkflowDefinition -Definition $wfdef</dev:code> <maml:remarks> <maml:para>Adds an existing workflow definition, retrieved by Get-PnPWorkflowDefinition, to a site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PnPWorkflowSubscription</command:name> <maml:description> <maml:para>Adds a workflow subscription to a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>PnPWorkflowSubscription</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPWorkflowSubscription</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the subscription</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DefinitionName</maml:name> <maml:description> <maml:para>The name of the workflow definition</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to add the workflow to</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>HistoryListName</maml:name> <maml:description> <maml:para>The name of the History list</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TaskListName</maml:name> <maml:description> <maml:para>The name of the task list</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartManually</maml:name> <maml:description> <maml:para>Switch if the workflow should be started manually, default value is 'true'</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartOnCreated</maml:name> <maml:description> <maml:para>Should the workflow run when an new item is created</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartOnChanged</maml:name> <maml:description> <maml:para>Should the workflow run when an item is changed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AssociationValues</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AssociationValues</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DefinitionName</maml:name> <maml:description> <maml:para>The name of the workflow definition</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>HistoryListName</maml:name> <maml:description> <maml:para>The name of the History list</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to add the workflow to</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the subscription</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartManually</maml:name> <maml:description> <maml:para>Switch if the workflow should be started manually, default value is 'true'</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartOnChanged</maml:name> <maml:description> <maml:para>Should the workflow run when an item is changed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartOnCreated</maml:name> <maml:description> <maml:para>Should the workflow run when an new item is created</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TaskListName</maml:name> <maml:description> <maml:para>The name of the task list</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Add-PnPWorkflowSubscription -Name MyWorkflow -DefinitionName SendMessageWf -list $list</dev:code> <maml:remarks> <maml:para>Adds an Workflow with the name 'SendMessageWf' to the list $list.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $list | Add-PnPWorkflowSubscription -Name MyWorkflow -DefinitionName SendMessageWf</dev:code> <maml:remarks> <maml:para>Adds an Workflow with the name "SendMessageWf" to the list $list.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPList -Identity "MyCustomList" | Add-PnPWorkflowSubscription -Name MyWorkflow -DefinitionName SendMessageWf</dev:code> <maml:remarks> <maml:para>Adds an Workflow with the name "SendMessageWf" to the list "MyCustomList".</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Apply-PnPProvisioningTemplate</command:name> <maml:description> <maml:para>Applies a site template to a web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Apply</command:verb> <command:noun>PnPProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Apply-PnPProvisioningTemplate</maml:name> <command:parameter required="false" position="named"> <maml:name>InputInstance</maml:name> <maml:description> <maml:para>Allows you to provide an in-memory instance of the ProvisioningTemplate type of the PnP Core Component. When using this parameter, the -Path parameter refers to the path of any supporting file for the template.</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningTemplate</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>ID of the template to use from the xml file containing the provisioning template. If not specified and multiple ProvisioningTemplate elements exist, the last one will be used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceFolder</maml:name> <maml:description> <maml:para>Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the provisioning template is located will be used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteSystemPropertyBagValues</maml:name> <maml:description> <maml:para>Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreDuplicateDataRowErrors</maml:name> <maml:description> <maml:para>Ignore duplicate data row errors when the data row in the template already exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionContentTypesToSubWebs</maml:name> <maml:description> <maml:para>If set content types will be provisioned if the target web is a subweb.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionFieldsToSubWebs</maml:name> <maml:description> <maml:para>If set fields will be provisioned if the target web is a subweb.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearNavigation</maml:name> <maml:description> <maml:para>Override the RemoveExistingNodes attribute in the Navigation elements of the template. If you specify this value the navigation nodes will always be removed before adding the nodes in the template</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Allows you to specify parameters that can be referred to in the template by means of the {parameter:<Key>} token. See examples on how to use this parameter.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Handlers</maml:name> <maml:description> <maml:para>Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying. Visit https://docs.microsoft.com/dotnet/api/officedevpnp.core.framework.provisioning.model.handlers for possible values.</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeHandlers</maml:name> <maml:description> <maml:para>Allows you to run all handlers, excluding the ones specified.</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExtensibilityHandlers</maml:name> <maml:description> <maml:para>Allows you to specify ExtensbilityHandlers to execute while applying a template</maml:para> </maml:description> <command:parameterValue required="true">ExtensibilityHandler[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while applying a template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Apply-PnPProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml or pnp file containing the provisioning template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>ID of the template to use from the xml file containing the provisioning template. If not specified and multiple ProvisioningTemplate elements exist, the last one will be used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceFolder</maml:name> <maml:description> <maml:para>Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the provisioning template is located will be used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteSystemPropertyBagValues</maml:name> <maml:description> <maml:para>Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreDuplicateDataRowErrors</maml:name> <maml:description> <maml:para>Ignore duplicate data row errors when the data row in the template already exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionContentTypesToSubWebs</maml:name> <maml:description> <maml:para>If set content types will be provisioned if the target web is a subweb.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionFieldsToSubWebs</maml:name> <maml:description> <maml:para>If set fields will be provisioned if the target web is a subweb.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearNavigation</maml:name> <maml:description> <maml:para>Override the RemoveExistingNodes attribute in the Navigation elements of the template. If you specify this value the navigation nodes will always be removed before adding the nodes in the template</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Allows you to specify parameters that can be referred to in the template by means of the {parameter:<Key>} token. See examples on how to use this parameter.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Handlers</maml:name> <maml:description> <maml:para>Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying. Visit https://docs.microsoft.com/dotnet/api/officedevpnp.core.framework.provisioning.model.handlers for possible values.</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeHandlers</maml:name> <maml:description> <maml:para>Allows you to run all handlers, excluding the ones specified.</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExtensibilityHandlers</maml:name> <maml:description> <maml:para>Allows you to specify ExtensbilityHandlers to execute while applying a template</maml:para> </maml:description> <command:parameterValue required="true">ExtensibilityHandler[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while applying a template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ClearNavigation</maml:name> <maml:description> <maml:para>Override the RemoveExistingNodes attribute in the Navigation elements of the template. If you specify this value the navigation nodes will always be removed before adding the nodes in the template</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeHandlers</maml:name> <maml:description> <maml:para>Allows you to run all handlers, excluding the ones specified.</maml:para> </maml:description> <command:parameterValue required="false">Handlers</command:parameterValue> <dev:type> <maml:name>Handlers</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExtensibilityHandlers</maml:name> <maml:description> <maml:para>Allows you to specify ExtensbilityHandlers to execute while applying a template</maml:para> </maml:description> <command:parameterValue required="false">ExtensibilityHandler[]</command:parameterValue> <dev:type> <maml:name>ExtensibilityHandler[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Handlers</maml:name> <maml:description> <maml:para>Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying. Visit https://docs.microsoft.com/dotnet/api/officedevpnp.core.framework.provisioning.model.handlers for possible values.</maml:para> </maml:description> <command:parameterValue required="false">Handlers</command:parameterValue> <dev:type> <maml:name>Handlers</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreDuplicateDataRowErrors</maml:name> <maml:description> <maml:para>Ignore duplicate data row errors when the data row in the template already exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InputInstance</maml:name> <maml:description> <maml:para>Allows you to provide an in-memory instance of the ProvisioningTemplate type of the PnP Core Component. When using this parameter, the -Path parameter refers to the path of any supporting file for the template.</maml:para> </maml:description> <command:parameterValue required="false">ProvisioningTemplate</command:parameterValue> <dev:type> <maml:name>ProvisioningTemplate</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteSystemPropertyBagValues</maml:name> <maml:description> <maml:para>Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Allows you to specify parameters that can be referred to in the template by means of the {parameter:<Key>} token. See examples on how to use this parameter.</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml or pnp file containing the provisioning template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionContentTypesToSubWebs</maml:name> <maml:description> <maml:para>If set content types will be provisioned if the target web is a subweb.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionFieldsToSubWebs</maml:name> <maml:description> <maml:para>If set fields will be provisioned if the target web is a subweb.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceFolder</maml:name> <maml:description> <maml:para>Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the provisioning template is located will be used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>ID of the template to use from the xml file containing the provisioning template. If not specified and multiple ProvisioningTemplate elements exist, the last one will be used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while applying a template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-PnPProvisioningTemplate -Path template.xml</dev:code> <maml:remarks> <maml:para>Applies a site template in XML format to the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-PnPProvisioningTemplate -Path template.xml -ResourceFolder c:\provisioning\resources</dev:code> <maml:remarks> <maml:para>Applies a site template in XML format to the current web. Any resources like files that are referenced in the template will be retrieved from the folder as specified with the ResourceFolder parameter.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-PnPProvisioningTemplate -Path template.xml -Parameters @{"ListTitle"="Projects";"parameter2"="a second value"}</dev:code> <maml:remarks> <maml:para>Applies a site template in XML format to the current web. It will populate the parameter in the template the values as specified and in the template you can refer to those values with the {parameter:<key>} token. For instance with the example above, specifying {parameter:ListTitle} in your template will translate to 'Projects' when applying the template. These tokens can be used in most string values in a template.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-PnPProvisioningTemplate -Path template.xml -Handlers Lists, SiteSecurity</dev:code> <maml:remarks> <maml:para>Applies a site template in XML format to the current web. It will only apply the lists and site security part of the template.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-PnPProvisioningTemplate -Path template.pnp</dev:code> <maml:remarks> <maml:para>Applies a site template from a pnp package to the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-PnPProvisioningTemplate -Path https://tenant.sharepoint.com/sites/templatestorage/Documents/template.pnp</dev:code> <maml:remarks> <maml:para>Applies a site template from a pnp package stored in a library to the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS:> $handler1 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 PS:> $handler2 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler2 PS:> Apply-PnPProvisioningTemplate -Path NewTemplate.xml -ExtensibilityHandlers $handler1,$handler2</dev:code> <maml:remarks> <maml:para>This will create two new ExtensibilityHandler objects that are run while provisioning the template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 8---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-PnPProvisioningTemplate -Path .\ -InputInstance $template</dev:code> <maml:remarks> <maml:para>Applies a site template from an in-memory instance of a ProvisioningTemplate type of the PnP Core Component, reading the supporting files, if any, from the current (.\) path. The syntax can be used together with any other supported parameters.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 9---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-PnPProvisioningTemplate -Path .\template.xml -TemplateId "MyTemplate"</dev:code> <maml:remarks> <maml:para>Applies the ProvisioningTemplate with the ID "MyTemplate" located in the template definition file template.xml.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPSitePolicy</command:name> <maml:description> <maml:para>Sets a site policy</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPSitePolicy</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPSitePolicy</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the site policy to apply</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the site policy to apply</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSitePolicy -Name "Contoso HBI"</dev:code> <maml:remarks> <maml:para>This applies a site policy with the name "Contoso HBI" to the current site. The policy needs to be available in the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Apply-PnPTenantTemplate</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Applies a tenant template to the current tenant. You must be a SharePoint Online global administrator to run the cmdlet.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Apply</command:verb> <command:noun>PnPTenantTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Apply-PnPTenantTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml or pnp file containing the tenant template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SequenceId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceFolder</maml:name> <maml:description> <maml:para>Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the tenant template is located will be used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Handlers</maml:name> <maml:description> <maml:para>Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying.</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeHandlers</maml:name> <maml:description> <maml:para>Allows you to run all handlers, excluding the ones specified.</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExtensibilityHandlers</maml:name> <maml:description> <maml:para>Allows you to specify ExtensbilityHandlers to execute while applying a template</maml:para> </maml:description> <command:parameterValue required="true">ExtensibilityHandler[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while applying a template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Allows you to specify parameters that can be referred to in the tenant template by means of the {parameter:<Key>} token. See examples on how to use this parameter.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteSystemPropertyBagValues</maml:name> <maml:description> <maml:para>Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreDuplicateDataRowErrors</maml:name> <maml:description> <maml:para>Ignore duplicate data row errors when the data row in the template already exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionContentTypesToSubWebs</maml:name> <maml:description> <maml:para>If set content types will be provisioned if the target web is a subweb.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionFieldsToSubWebs</maml:name> <maml:description> <maml:para>If set fields will be provisioned if the target web is a subweb.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearNavigation</maml:name> <maml:description> <maml:para>Override the RemoveExistingNodes attribute in the Navigation elements of the template. If you specify this value the navigation nodes will always be removed before adding the nodes in the template</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="true">ApplyConfigurationPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Apply-PnPTenantTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ProvisioningHierarchy</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SequenceId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceFolder</maml:name> <maml:description> <maml:para>Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the tenant template is located will be used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Handlers</maml:name> <maml:description> <maml:para>Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying.</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeHandlers</maml:name> <maml:description> <maml:para>Allows you to run all handlers, excluding the ones specified.</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExtensibilityHandlers</maml:name> <maml:description> <maml:para>Allows you to specify ExtensbilityHandlers to execute while applying a template</maml:para> </maml:description> <command:parameterValue required="true">ExtensibilityHandler[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while applying a template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Allows you to specify parameters that can be referred to in the tenant template by means of the {parameter:<Key>} token. See examples on how to use this parameter.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteSystemPropertyBagValues</maml:name> <maml:description> <maml:para>Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreDuplicateDataRowErrors</maml:name> <maml:description> <maml:para>Ignore duplicate data row errors when the data row in the template already exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionContentTypesToSubWebs</maml:name> <maml:description> <maml:para>If set content types will be provisioned if the target web is a subweb.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionFieldsToSubWebs</maml:name> <maml:description> <maml:para>If set fields will be provisioned if the target web is a subweb.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearNavigation</maml:name> <maml:description> <maml:para>Override the RemoveExistingNodes attribute in the Navigation elements of the template. If you specify this value the navigation nodes will always be removed before adding the nodes in the template</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="true">ApplyConfigurationPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ClearNavigation</maml:name> <maml:description> <maml:para>Override the RemoveExistingNodes attribute in the Navigation elements of the template. If you specify this value the navigation nodes will always be removed before adding the nodes in the template</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="false">ApplyConfigurationPipeBind</command:parameterValue> <dev:type> <maml:name>ApplyConfigurationPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeHandlers</maml:name> <maml:description> <maml:para>Allows you to run all handlers, excluding the ones specified.</maml:para> </maml:description> <command:parameterValue required="false">Handlers</command:parameterValue> <dev:type> <maml:name>Handlers</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExtensibilityHandlers</maml:name> <maml:description> <maml:para>Allows you to specify ExtensbilityHandlers to execute while applying a template</maml:para> </maml:description> <command:parameterValue required="false">ExtensibilityHandler[]</command:parameterValue> <dev:type> <maml:name>ExtensibilityHandler[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Handlers</maml:name> <maml:description> <maml:para>Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying.</maml:para> </maml:description> <command:parameterValue required="false">Handlers</command:parameterValue> <dev:type> <maml:name>Handlers</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreDuplicateDataRowErrors</maml:name> <maml:description> <maml:para>Ignore duplicate data row errors when the data row in the template already exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteSystemPropertyBagValues</maml:name> <maml:description> <maml:para>Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Allows you to specify parameters that can be referred to in the tenant template by means of the {parameter:<Key>} token. See examples on how to use this parameter.</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml or pnp file containing the tenant template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionContentTypesToSubWebs</maml:name> <maml:description> <maml:para>If set content types will be provisioned if the target web is a subweb.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionFieldsToSubWebs</maml:name> <maml:description> <maml:para>If set fields will be provisioned if the target web is a subweb.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceFolder</maml:name> <maml:description> <maml:para>Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the tenant template is located will be used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SequenceId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ProvisioningHierarchy</command:parameterValue> <dev:type> <maml:name>ProvisioningHierarchy</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while applying a template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-PnPTenantTemplate -Path myfile.pnp</dev:code> <maml:remarks> <maml:para>Will read the tenant template from the filesystem and will apply the sequences in the template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-PnPTenantTemplate -Path myfile.pnp -SequenceId "mysequence"</dev:code> <maml:remarks> <maml:para>Will read the tenant template from the filesystem and will apply the specified sequence in the template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Apply-PnPTenantTemplate -Path myfile.pnp -Parameters @{"ListTitle"="Projects";"parameter2"="a second value"}</dev:code> <maml:remarks> <maml:para>Applies a tenant template to the current tenant. It will populate the parameter in the template the values as specified and in the template you can refer to those values with the {parameter:<key>} token. For instance with the example above, specifying {parameter:ListTitle} in your template will translate to 'Projects' when applying the template. These tokens can be used in most string values in a template.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Approve-PnPTenantServicePrincipalPermissionRequest</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Approves a permission request for the current tenant's "SharePoint Online Client" service principal</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Approve</command:verb> <command:noun>PnPTenantServicePrincipalPermissionRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Approves a permission request for the current tenant's "SharePoint Online Client" service principal The return value of a successful call is a permission grant object. To get the collection of permission grants for the "SharePoint Online Client" service principal, use the Get-PnPTenantServicePrincipalPermissionGrants command. Approving a permission request also removes that request from the list of permission requests.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Approve-PnPTenantServicePrincipalPermissionRequest</maml:name> <command:parameter required="true" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Clear-PnPDefaultColumnValues</command:name> <maml:description> <maml:para>Clear default column values for a document library</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>PnPDefaultColumnValues</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Clear default column values for a document library, per folder, or for the root folder if the folder parameter has not been specified.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPDefaultColumnValues</maml:name> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The internal name, id or a reference to a field</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Name or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>A library relative folder path, if not specified it will set the default column values on the root folder of the library ('/')</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The internal name, id or a reference to a field</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>A library relative folder path, if not specified it will set the default column values on the root folder of the library ('/')</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Name or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Clear-PnPDefaultColumnValues -List Documents -Field MyField</dev:code> <maml:remarks> <maml:para>Clears the default value for the field MyField on a library</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Clear-PnPDefaultColumnValues -List Documents -Field MyField -Folder A</dev:code> <maml:remarks> <maml:para>Clears the default value for the field MyField on the folder A on a library</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Clear-PnPListItemAsRecord</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Undeclares a list item as a record</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>PnPListItemAsRecord</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPListItemAsRecord</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> <dev:type> <maml:name>ListItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Clear-PnPListItemAsRecord -List "Documents" -Identity 4</dev:code> <maml:remarks> <maml:para>Undeclares the document in the documents library with id 4 as a record</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Clear-PnPRecycleBinItem</command:name> <maml:description> <maml:para>Permanently deletes all or a specific recycle bin item</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>PnPRecycleBinItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPRecycleBinItem</maml:name> <command:parameter required="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Clears all items</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SecondStageOnly</maml:name> <maml:description> <maml:para>If provided, only all the items in the second stage recycle bin will be cleared</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to permanently delete the recycle bin item</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Clear-PnPRecycleBinItem</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id of the recycle bin item or the recycle bin item itself to permanently delete</maml:para> </maml:description> <command:parameterValue required="true">RecycleBinItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to permanently delete the recycle bin item</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Clears all items</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to permanently delete the recycle bin item</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id of the recycle bin item or the recycle bin item itself to permanently delete</maml:para> </maml:description> <command:parameterValue required="true">RecycleBinItemPipeBind</command:parameterValue> <dev:type> <maml:name>RecycleBinItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SecondStageOnly</maml:name> <maml:description> <maml:para>If provided, only all the items in the second stage recycle bin will be cleared</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPRecycleBinItem | ? FileLeafName -like "*.docx" | Clear-PnpRecycleBinItem</dev:code> <maml:remarks> <maml:para>Permanently deletes all the items in the first and second stage recycle bins of which the file names have the .docx extension</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Clear-PnpRecycleBinItem -Identity 72e4d749-d750-4989-b727-523d6726e442</dev:code> <maml:remarks> <maml:para>Permanently deletes the recycle bin item with Id 72e4d749-d750-4989-b727-523d6726e442 from the recycle bin</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Clear-PnpRecycleBinItem -Identity $item -Force</dev:code> <maml:remarks> <maml:para>Permanently deletes the recycle bin item stored under variable $item from the recycle bin without asking for confirmation from the end user first</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Clear-PnPTenantAppCatalogUrl</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes the url of the tenant scoped app catalog. It will not delete the site collection itself.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>PnPTenantAppCatalogUrl</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPTenantAppCatalogUrl</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Clear-PnPTenantAppCatalogUrl</dev:code> <maml:remarks> <maml:para>Removes the url of the tenant scoped app catalog</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Clear-PnPTenantRecycleBinItem</command:name> <maml:description> <maml:para>Permanently deletes a site collection from the tenant scoped recycle bin</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>PnPTenantRecycleBinItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-PnPTenantRecycleBinItem cmdlet allows a site collection that has been deleted and still exists in the tenant recycle bin to be permanently deleted from the recycle bin as well.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPTenantRecycleBinItem</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the site collection to permanently delete from the tenant recycle bin</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If provided, the PowerShell execution will halt until the operation has completed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to permanently delete the site collection from the tenant recycle bin</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to permanently delete the site collection from the tenant recycle bin</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the site collection to permanently delete from the tenant recycle bin</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If provided, the PowerShell execution will halt until the operation has completed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Clear-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso</dev:code> <maml:remarks> <maml:para>This will permanently delete site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the tenant recycle bin</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Clear-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso -Wait</dev:code> <maml:remarks> <maml:para>This will permanently delete site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the tenant recycle bin and will wait with executing further PowerShell commands until the operation has completed</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Connect-PnPOnline</command:name> <maml:description> <maml:para>Connect to a SharePoint site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>PnPOnline</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>If no credentials have been specified, and the CurrentCredentials parameter has not been specified, you will be prompted for credentials.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Credentials of the user to connect with. Either specify a PSCredential object or a string. In case of a string value a lookup will be done to the Generic Credentials section of the Windows Credentials in the Windows Credential Manager for the correct credentials.</maml:para> </maml:description> <command:parameterValue required="true">CredentialPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CurrentCredentials</maml:name> <maml:description> <maml:para>If you want to connect with the current user credentials</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseAdfs</maml:name> <maml:description> <maml:para>If you want to connect to your on-premises SharePoint farm using ADFS</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseAdfsCert</maml:name> <maml:description> <maml:para>If you want to connect to your SharePoint farm using ADFS with Certificate Authentication</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Kerberos</maml:name> <maml:description> <maml:para>Authenticate using Kerberos to an on-premises ADFS instance.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LoginProviderName</maml:name> <maml:description> <maml:para>The name of the ADFS trusted login provider</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 1800000</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AuthenticationMode</maml:name> <maml:description> <maml:para>Specify to use for instance use forms based authentication (FBA)</maml:para> </maml:description> <command:parameterValue required="true">ClientAuthenticationMode</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The array of permission scopes for the Microsoft Graph API.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TenantAdminUrl</maml:name> <maml:description> <maml:para>The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://<tenantname>-admin.sharepoint.com where appropriate.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSslErrors</maml:name> <maml:description> <maml:para>Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Connect with an existing Access Token</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 1800000</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>Graph</maml:name> <maml:description> <maml:para>Log in using the PnP O365 Management Shell application towards the Graph. You will be asked to consent to: * Read and write managed metadata * Have full control of all site collections * Read user profiles * Invite guest users to the organization * Read and write all groups * Read and write directory data * Read and write identity providers * Access the directory as you </maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LaunchBrowser</maml:name> <maml:description> <maml:para>Launch a browser automatically and copy the code to enter to the clipboard</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSslErrors</maml:name> <maml:description> <maml:para>Ignores any SSL errors. To be used i.e. when connecting through a proxy to the Microsoft Graph API which has SSL interception enabled.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The array of permission scopes for the Microsoft Graph API.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSslErrors</maml:name> <maml:description> <maml:para>Ignores any SSL errors. To be used i.e. when connecting through a proxy to the Microsoft Graph API which has SSL interception enabled.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>UseWebLogin</maml:name> <maml:description> <maml:para>If you want to connect to SharePoint with browser based login. This is required when you have multi-factor authentication (MFA) enabled.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 1800000</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The array of permission scopes for the Microsoft Graph API.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TenantAdminUrl</maml:name> <maml:description> <maml:para>The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://<tenantname>-admin.sharepoint.com where appropriate.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSslErrors</maml:name> <maml:description> <maml:para>Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>SPOManagementShell</maml:name> <maml:description> <maml:para>Log in using the SharePoint Online Management Shell application</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 1800000</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearTokenCache</maml:name> <maml:description> <maml:para>Clears the token cache.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The array of permission scopes for the Microsoft Graph API.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TenantAdminUrl</maml:name> <maml:description> <maml:para>The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://<tenantname>-admin.sharepoint.com where appropriate.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSslErrors</maml:name> <maml:description> <maml:para>Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>PnPO365ManagementShell</maml:name> <maml:description> <maml:para>Log in using the PnP O365 Management Shell application. You will be asked to consent to: * Read and write managed metadata * Have full control of all site collections * Read user profiles * Invite guest users to the organization * Read and write all groups * Read and write directory data * Read and write identity providers * Access the directory as you</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LaunchBrowser</maml:name> <maml:description> <maml:para>Launch a browser automatically and copy the code to enter to the clipboard</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>AppId</maml:name> <maml:description> <maml:para>The Application Client ID to use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AppSecret</maml:name> <maml:description> <maml:para>The Application Client Secret to use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 1800000</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>Authentication realm. If not specified will be resolved from the url specified.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The array of permission scopes for the Microsoft Graph API.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TenantAdminUrl</maml:name> <maml:description> <maml:para>The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://<tenantname>-admin.sharepoint.com where appropriate.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSslErrors</maml:name> <maml:description> <maml:para>Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The Client ID of the Azure AD Application</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>RedirectUri</maml:name> <maml:description> <maml:para>The Redirect URI of the Azure AD Application</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 1800000</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearTokenCache</maml:name> <maml:description> <maml:para>Clears the token cache.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The array of permission scopes for the Microsoft Graph API.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TenantAdminUrl</maml:name> <maml:description> <maml:para>The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://<tenantname>-admin.sharepoint.com where appropriate.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSslErrors</maml:name> <maml:description> <maml:para>Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The Client ID of the Azure AD Application</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>The Azure AD Tenant name,e.g. mycompany.onmicrosoft.com</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 1800000</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CertificatePath</maml:name> <maml:description> <maml:para>Path to the certificate containing the private key (*.pfx)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CertificateBase64Encoded</maml:name> <maml:description> <maml:para>Base64 Encoded X509Certificate2 certificate containing the private key to authenticate the requests to SharePoint Online such as retrieved in Azure Functions from Azure KeyVault</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>X509Certificate2 reference containing the private key to authenticate the requests to SharePoint Online</maml:para> </maml:description> <command:parameterValue required="true">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CertificatePassword</maml:name> <maml:description> <maml:para>Password to the certificate (*.pfx)</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The array of permission scopes for the Microsoft Graph API.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TenantAdminUrl</maml:name> <maml:description> <maml:para>The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://<tenantname>-admin.sharepoint.com where appropriate.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSslErrors</maml:name> <maml:description> <maml:para>Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The Client ID of the Azure AD Application</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>The Azure AD Tenant name,e.g. mycompany.onmicrosoft.com</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 180000</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TenantAdminUrl</maml:name> <maml:description> <maml:para>The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://<tenantname>-admin.sharepoint.com where appropriate.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSslErrors</maml:name> <maml:description> <maml:para>Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>AppId</maml:name> <maml:description> <maml:para>The client id of the app which gives you access to the Microsoft Graph API.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AppSecret</maml:name> <maml:description> <maml:para>The app key of the app which gives you access to the Microsoft Graph API.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AADDomain</maml:name> <maml:description> <maml:para>The AAD where the O365 app is registered. Eg.: contoso.com, or contoso.onmicrosoft.com.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSslErrors</maml:name> <maml:description> <maml:para>Ignores any SSL errors. To be used i.e. when connecting through a proxy to the Microsoft Graph API which has SSL interception enabled.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The Client ID of the Azure AD Application</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>The Azure AD Tenant name,e.g. mycompany.onmicrosoft.com</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>Certificate thumbprint</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 1800000</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TenantAdminUrl</maml:name> <maml:description> <maml:para>The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://<tenantname>-admin.sharepoint.com where appropriate.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSslErrors</maml:name> <maml:description> <maml:para>Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The Client ID of the Azure AD Application</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>The Azure AD Tenant name,e.g. mycompany.onmicrosoft.com</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PEMCertificate</maml:name> <maml:description> <maml:para>PEM encoded certificate</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PEMPrivateKey</maml:name> <maml:description> <maml:para>PEM encoded private key for the certificate</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 1800000</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CertificatePassword</maml:name> <maml:description> <maml:para>Password to the certificate (*.pfx)</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TenantAdminUrl</maml:name> <maml:description> <maml:para>The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://<tenantname>-admin.sharepoint.com where appropriate.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSslErrors</maml:name> <maml:description> <maml:para>Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>AADDomain</maml:name> <maml:description> <maml:para>The AAD where the O365 app is registered. Eg.: contoso.com, or contoso.onmicrosoft.com.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Connect with an existing Access Token</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AppId</maml:name> <maml:description> <maml:para>The Application Client ID to use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>AppSecret</maml:name> <maml:description> <maml:para>The Application Client Secret to use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AuthenticationMode</maml:name> <maml:description> <maml:para>Specify to use for instance use forms based authentication (FBA)</maml:para> </maml:description> <command:parameterValue required="false">ClientAuthenticationMode</command:parameterValue> <dev:type> <maml:name>ClientAuthenticationMode</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="false">AzureEnvironment</command:parameterValue> <dev:type> <maml:name>AzureEnvironment</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>X509Certificate2 reference containing the private key to authenticate the requests to SharePoint Online</maml:para> </maml:description> <command:parameterValue required="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CertificateBase64Encoded</maml:name> <maml:description> <maml:para>Base64 Encoded X509Certificate2 certificate containing the private key to authenticate the requests to SharePoint Online such as retrieved in Azure Functions from Azure KeyVault</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CertificatePassword</maml:name> <maml:description> <maml:para>Password to the certificate (*.pfx)</maml:para> </maml:description> <command:parameterValue required="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CertificatePath</maml:name> <maml:description> <maml:para>Path to the certificate containing the private key (*.pfx)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearTokenCache</maml:name> <maml:description> <maml:para>Clears the token cache.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The Client ID of the Azure AD Application</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateDrive</maml:name> <maml:description> <maml:para>If you want to create a PSDrive connected to the URL</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Credentials of the user to connect with. Either specify a PSCredential object or a string. In case of a string value a lookup will be done to the Generic Credentials section of the Windows Credentials in the Windows Credential Manager for the correct credentials.</maml:para> </maml:description> <command:parameterValue required="false">CredentialPipeBind</command:parameterValue> <dev:type> <maml:name>CredentialPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CurrentCredentials</maml:name> <maml:description> <maml:para>If you want to connect with the current user credentials</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DriveName</maml:name> <maml:description> <maml:para>Name of the PSDrive to create (default: SPO)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Graph</maml:name> <maml:description> <maml:para>Log in using the PnP O365 Management Shell application towards the Graph. You will be asked to consent to: * Read and write managed metadata * Have full control of all site collections * Read user profiles * Invite guest users to the organization * Read and write all groups * Read and write directory data * Read and write identity providers * Access the directory as you </maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IgnoreSslErrors</maml:name> <maml:description> <maml:para>Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm using self signed certificates or using a certificate authority not trusted by this machine.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Kerberos</maml:name> <maml:description> <maml:para>Authenticate using Kerberos to an on-premises ADFS instance.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LaunchBrowser</maml:name> <maml:description> <maml:para>Launch a browser automatically and copy the code to enter to the clipboard</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LoginProviderName</maml:name> <maml:description> <maml:para>The name of the ADFS trusted login provider</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinimalHealthScore</maml:name> <maml:description> <maml:para>Specifies a minimal server healthscore before any requests are executed.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoTelemetry</maml:name> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off in general or use the -NoTelemetry switch to turn it off for that session.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PEMCertificate</maml:name> <maml:description> <maml:para>PEM encoded certificate</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PEMPrivateKey</maml:name> <maml:description> <maml:para>PEM encoded private key for the certificate</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PnPO365ManagementShell</maml:name> <maml:description> <maml:para>Log in using the PnP O365 Management Shell application. You will be asked to consent to: * Read and write managed metadata * Have full control of all site collections * Read user profiles * Invite guest users to the organization * Read and write all groups * Read and write directory data * Read and write identity providers * Access the directory as you</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>Authentication realm. If not specified will be resolved from the url specified.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>RedirectUri</maml:name> <maml:description> <maml:para>The Redirect URI of the Azure AD Application</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestTimeout</maml:name> <maml:description> <maml:para>The request timeout. Default is 1800000</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Defines how often a retry should be executed if the server healthscore is not sufficient. Default is 10 times.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Defines how many seconds to wait before each retry. Default is 1 second.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The array of permission scopes for the Microsoft Graph API.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTenantAdminCheck</maml:name> <maml:description> <maml:para>Should we skip the check if this site is the Tenant admin site. Default is false</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SPOManagementShell</maml:name> <maml:description> <maml:para>Log in using the SharePoint Online Management Shell application</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>The Azure AD Tenant name,e.g. mycompany.onmicrosoft.com</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TenantAdminUrl</maml:name> <maml:description> <maml:para>The url to the Tenant Admin site. If not specified, the cmdlets will assume to connect automatically to https://<tenantname>-admin.sharepoint.com where appropriate.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>Certificate thumbprint</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection to connect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseAdfs</maml:name> <maml:description> <maml:para>If you want to connect to your on-premises SharePoint farm using ADFS</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseAdfsCert</maml:name> <maml:description> <maml:para>If you want to connect to your SharePoint farm using ADFS with Certificate Authentication</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>UseWebLogin</maml:name> <maml:description> <maml:para>If you want to connect to SharePoint with browser based login. This is required when you have multi-factor authentication (MFA) enabled.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com</dev:code> <maml:remarks> <maml:para>This will prompt for username and password and creates a context for the other PowerShell commands to use. When a generic credential is added to the Windows Credential Manager with https://contoso.sharepoint.com, PowerShell will not prompt for username and password.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -Credentials (Get-Credential)</dev:code> <maml:remarks> <maml:para>This will prompt for username and password and creates a context for the other PowerShell commands to use. </maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url http://yourlocalserver -CurrentCredentials</dev:code> <maml:remarks> <maml:para>This will use the current user credentials and connects to the server specified by the Url parameter.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url http://yourlocalserver -Credentials 'O365Creds'</dev:code> <maml:remarks> <maml:para>This will use credentials from the Windows Credential Manager, as defined by the label 'O365Creds'.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url http://yourlocalserver -Credentials (Get-Credential) -UseAdfs</dev:code> <maml:remarks> <maml:para>This will prompt for username and password and creates a context using ADFS to authenticate.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url http://yourlocalserver -UseAdfsCert</dev:code> <maml:remarks> <maml:para>This will enable you to select a certificate to create a context using ADFS to authenticate.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://yourserver -Credentials (Get-Credential) -CreateDrive PS:> cd SPO:\\ PS:> dir</dev:code> <maml:remarks> <maml:para>This will prompt you for credentials and creates a context for the other PowerShell commands to use. It will also create a SPO:\\ drive you can use to navigate around the site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 8---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://yourserver -Credentials (Get-Credential) -AuthenticationMode FormsAuthentication</dev:code> <maml:remarks> <maml:para>This will prompt you for credentials and creates a context for the other PowerShell commands to use. It assumes your server is configured for Forms Based Authentication (FBA)</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 9---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://contoso.sharepoint.de -AppId 344b8aab-389c-4e4a-8fa1-4c1ae2c0a60d -AppSecret a3f3faf33f3awf3a3sfs3f3ss3f4f4a3fawfas3ffsrrffssfd -AzureEnvironment Germany</dev:code> <maml:remarks> <maml:para>This will authenticate you to the German Azure environment using the German Azure endpoints for authentication</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 10---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -SPOManagementShell</dev:code> <maml:remarks> <maml:para>This will authenticate you using the SharePoint Online Management Shell application</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 11---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -PnPO365ManagementShell</dev:code> <maml:remarks> <maml:para>This will authenticate you using the PnP O365 Management Shell Multi-Tenant application. A browser window will have to be opened where you have to enter a code that is shown in your PowerShell window.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 12---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -PnPO365ManagementShell -LaunchBrowser</dev:code> <maml:remarks> <maml:para>This will authenticate you using the PnP O365 Management Shell Multi-Tenant application. A browser window will automatically open and the code you need to enter will be automatically copied to your clipboard.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 13---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -AccessToken $myaccesstoken</dev:code> <maml:remarks> <maml:para>This will authenticate you using the provided access token</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 14---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Scopes "Mail.Read","Files.Read"</dev:code> <maml:remarks> <maml:para>Connects to Azure AD and gets and OAuth 2.0 Access Token to consume the Microsoft Graph API including the declared permission scopes. The available permission scopes are defined at the following URL: https://docs.microsoft.com/en-us/graph/permissions-reference</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 15---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -AppId '<id>' -AppSecret '<secret>' -AADDomain 'contoso.onmicrosoft.com'</dev:code> <maml:remarks> <maml:para>Connects to the Microsoft Graph API using application permissions via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/Graph.ConnectUsingAppPermissions for a sample on how to get started.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 16---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '<id>' -Tenant 'contoso.onmicrosoft.com' -CertificatePath c:\absolute-path\to\pnp.pfx -CertificatePassword <if needed></dev:code> <maml:remarks> <maml:para>Connects to SharePoint using app-only tokens via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 17---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -ClientId <id> -CertificatePath 'c:\mycertificate.pfx' -CertificatePassword (ConvertTo-SecureString -AsPlainText 'myprivatekeypassword' -Force) -Url https://contoso.sharepoint.com -Tenant 'contoso.onmicrosoft.com'</dev:code> <maml:remarks> <maml:para>Connects using an Azure Active Directory registered application using a locally available certificate containing a private key. See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread for a sample on how to get started.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 18---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '<id>' -Tenant 'contoso.onmicrosoft.com' -Thumbprint 34CFAA860E5FB8C44335A38A097C1E41EEA206AA</dev:code> <maml:remarks> <maml:para>Connects to SharePoint using app-only tokens via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 19---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '<id>' -Tenant 'contoso.onmicrosoft.com' -PEMCertificate <PEM string> -PEMPrivateKey <PEM string> -CertificatePassword <if needed></dev:code> <maml:remarks> <maml:para>Connects to SharePoint using app-only tokens via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 20---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -ClientId <id> -CertificateBase64Encoded 'xxxx' -CertificatePassword (ConvertTo-SecureString -AsPlainText 'myprivatekeypassword' -Force) -Url https://contoso.sharepoint.com -Tenant 'contoso.onmicrosoft.com'</dev:code> <maml:remarks> <maml:para>Connects using an Azure Active Directory registered application using a certificate containing a private key encoded in base 64 such as received in an Azure Function when using Azure KeyVault. See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread for a sample on how to get started.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 21---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '<id>' -Tenant 'contoso.onmicrosoft.com' -Certificate <X509Certificate2></dev:code> <maml:remarks> <maml:para>Connects to SharePoint using app-only auth in combination with a certificate. See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread#using-this-principal-in-your-powershell-script-using-the-pnp-sites-core-library for a sample on how to get started.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 22---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -ClientId <id> -Certificate $cert -CertificatePassword (ConvertTo-SecureString -AsPlainText 'myprivatekeypassword' -Force) -Url https://contoso.sharepoint.com -Tenant 'contoso.onmicrosoft.com'</dev:code> <maml:remarks> <maml:para>Connects using an Azure Active Directory registered application using a certificate instance containing a private key. See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread for a sample on how to get started.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Convert-PnPFolderToProvisioningTemplate</command:name> <maml:description> <maml:para>Creates a pnp package file of an existing template xml, and includes all files in the current folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Convert</command:verb> <command:noun>PnPFolderToProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Convert-PnPFolderToProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Folder to process. If not specified the current folder will be used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="1"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Folder to process. If not specified the current folder will be used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Convert-PnPFolderToProvisioningTemplate -Out template.pnp</dev:code> <maml:remarks> <maml:para>Creates a pnp package file of an existing template xml, and includes all files in the current folder</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Convert-PnPFolderToProvisioningTemplate -Out template.pnp -Folder c:\temp</dev:code> <maml:remarks> <maml:para>Creates a pnp package file of an existing template xml, and includes all files in the c:\temp folder</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Convert-PnPProvisioningTemplate</command:name> <maml:description> <maml:para>Converts a provisioning template to an other schema version</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Convert</command:verb> <command:noun>PnPProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Convert-PnPProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml file containing the site template</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>The encoding type of the XML file, Unicode is default</maml:para> </maml:description> <command:parameterValue required="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ToSchema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="true">XMLPnPSchemaVersion</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>The encoding type of the XML file, Unicode is default</maml:para> </maml:description> <command:parameterValue required="false">Encoding</command:parameterValue> <dev:type> <maml:name>Encoding</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml file containing the site template</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ToSchema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="false">XMLPnPSchemaVersion</command:parameterValue> <dev:type> <maml:name>XMLPnPSchemaVersion</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Convert-PnPProvisioningTemplate -Path template.xml</dev:code> <maml:remarks> <maml:para>Converts a provisioning template to the latest schema and outputs the result to current console.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Convert-PnPProvisioningTemplate -Path template.xml -Out newtemplate.xml</dev:code> <maml:remarks> <maml:para>Converts a provisioning template to the latest schema and outputs the result the newtemplate.xml file.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Convert-PnPProvisioningTemplate -Path template.xml -Out newtemplate.xml -ToSchema V201512</dev:code> <maml:remarks> <maml:para>Converts a provisioning template to the latest schema using the 201512 schema and outputs the result the newtemplate.xml file.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Encoding:</maml:linkText> <maml:uri>https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>ConvertTo-PnPClientSidePage</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Converts a classic page (wiki or web part page) into a Client-Side Page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>ConvertTo</command:verb> <command:noun>PnPClientSidePage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-PnPClientSidePage</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page to convert</maml:para> </maml:description> <command:parameterValue required="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebPartMappingFile</maml:name> <maml:description> <maml:para>Path and name of the web part mapping file driving the transformation</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrites page if already existing</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TakeSourcePageName</maml:name> <maml:description> <maml:para>Created client side page takes name from previous classic page. Classic page gets renamed to previous_<Page>.aspx</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReplaceHomePageWithDefault</maml:name> <maml:description> <maml:para>Replaces a home page with a default stock modern home page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddPageAcceptBanner</maml:name> <maml:description> <maml:para>Adds the page accept banner web part. The actual web part is specified in webpartmapping.xml file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipItemLevelPermissionCopyToClientSidePage</maml:name> <maml:description> <maml:para>By default the item level permissions on a page are copied to the created client side page. Use this switch to prevent the copy</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipUrlRewriting</maml:name> <maml:description> <maml:para>If transforming cross site then by default urls in html and summarylinks are rewritten for the target site. Set this flag to prevent that</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipDefaultUrlRewriting</maml:name> <maml:description> <maml:para>Set this flag to prevent the default URL rewriting while you still want to do URL rewriting using a custom URL mapping file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UrlMappingFile</maml:name> <maml:description> <maml:para>File holding custom URL mapping definitions</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearCache</maml:name> <maml:description> <maml:para>Clears the cache. Can be needed if you've installed a new web part to the site and want to use that in a custom webpartmapping file. Restarting your PS session has the same effect</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CopyPageMetadata</maml:name> <maml:description> <maml:para>Copies the page metadata to the created modern page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddTableListImageAsImageWebPart</maml:name> <maml:description> <maml:para>When an image lives inside a table/list then it's also created as separate image web part underneath that table/list by default. Use this switch set to $false to change that</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseCommunityScriptEditor</maml:name> <maml:description> <maml:para>Uses the community script editor (https://github.com/SharePoint/sp-dev-fx-webparts/tree/master/samples/react-script-editor) as replacement for the classic script editor web part</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SummaryLinksToHtml</maml:name> <maml:description> <maml:para>By default summarylinks web parts are replaced by QuickLinks, but you can transform to plain html by setting this switch</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TargetWebUrl</maml:name> <maml:description> <maml:para>Url of the target web that will receive the modern page. Defaults to null which means in-place transformation</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogType</maml:name> <maml:description> <maml:para>Allows to generate a transformation log (File | SharePoint)</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePageTransformatorLogType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogFolder</maml:name> <maml:description> <maml:para>Folder in where the log file will be created (if LogType==File)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogSkipFlush</maml:name> <maml:description> <maml:para>By default each cmdlet invocation will result in a log file, use the -SkipLogFlush to delay the log flushing. The first call without -SkipLogFlush will then write all log entries to a single log</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogVerbose</maml:name> <maml:description> <maml:para>Configure logging to include verbose log entries</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DontPublish</maml:name> <maml:description> <maml:para>Don't publish the created modern page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>KeepPageCreationModificationInformation</maml:name> <maml:description> <maml:para>Keep the author, editor, created and modified information from the source page (when source page lives in SPO)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetAuthorInPageHeader</maml:name> <maml:description> <maml:para>Set's the author of the source page as author in the modern page header (when source page lives in SPO)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PostAsNews</maml:name> <maml:description> <maml:para>Post the created, and published, modern page as news</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisablePageComments</maml:name> <maml:description> <maml:para>Disable comments for the created modern page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishingPage</maml:name> <maml:description> <maml:para>I'm transforming a publishing page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BlogPage</maml:name> <maml:description> <maml:para>I'm transforming a blog page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DelveBlogPage</maml:name> <maml:description> <maml:para>I'm transforming a Delve blog page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DelveKeepSubTitle</maml:name> <maml:description> <maml:para>Transform the possible sub title as topic header on the modern page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PageLayoutMapping</maml:name> <maml:description> <maml:para>Path and name of the page layout mapping file driving the publishing page transformation</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishingTargetPageName</maml:name> <maml:description> <maml:para>Name for the target page (only applies to publishing page transformation)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TargetPageName</maml:name> <maml:description> <maml:para>Name for the target page (only applies when doing cross site page transformation)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TargetPageFolder</maml:name> <maml:description> <maml:para>Folder to create the target page in (will be used in conjunction with auto-generated folders that ensure page name uniqueness)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TargetPageFolderOverridesDefaultFolder</maml:name> <maml:description> <maml:para>When setting a target page folder then the target page folder overrides possibly default folder path (e.g. in the source page lived in a folder) instead of being appended to it</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveEmptySectionsAndColumns</maml:name> <maml:description> <maml:para>Remove empty sections and columns after transformation of the page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TargetConnection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipUserMapping</maml:name> <maml:description> <maml:para>Disables user mapping during transformation</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserMappingFile</maml:name> <maml:description> <maml:para>Specifies a user mapping file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermMappingFile</maml:name> <maml:description> <maml:para>Specifies a taxonomy term mapping file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTermStoreMapping</maml:name> <maml:description> <maml:para>Disables term mapping during transformation</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LDAPConnectionString</maml:name> <maml:description> <maml:para>Specifies a LDAP connection string e.g. LDAP://OU=Users,DC=Contoso,DC=local</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Library</maml:name> <maml:description> <maml:para>The name of the library containing the page. If SitePages then please omit this parameter</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder to load the provided page from. If not provided all folders are searched</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AddPageAcceptBanner</maml:name> <maml:description> <maml:para>Adds the page accept banner web part. The actual web part is specified in webpartmapping.xml file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddTableListImageAsImageWebPart</maml:name> <maml:description> <maml:para>When an image lives inside a table/list then it's also created as separate image web part underneath that table/list by default. Use this switch set to $false to change that</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BlogPage</maml:name> <maml:description> <maml:para>I'm transforming a blog page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearCache</maml:name> <maml:description> <maml:para>Clears the cache. Can be needed if you've installed a new web part to the site and want to use that in a custom webpartmapping file. Restarting your PS session has the same effect</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CopyPageMetadata</maml:name> <maml:description> <maml:para>Copies the page metadata to the created modern page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DelveBlogPage</maml:name> <maml:description> <maml:para>I'm transforming a Delve blog page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DelveKeepSubTitle</maml:name> <maml:description> <maml:para>Transform the possible sub title as topic header on the modern page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisablePageComments</maml:name> <maml:description> <maml:para>Disable comments for the created modern page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DontPublish</maml:name> <maml:description> <maml:para>Don't publish the created modern page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder to load the provided page from. If not provided all folders are searched</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page to convert</maml:para> </maml:description> <command:parameterValue required="true">PagePipeBind</command:parameterValue> <dev:type> <maml:name>PagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>KeepPageCreationModificationInformation</maml:name> <maml:description> <maml:para>Keep the author, editor, created and modified information from the source page (when source page lives in SPO)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LDAPConnectionString</maml:name> <maml:description> <maml:para>Specifies a LDAP connection string e.g. LDAP://OU=Users,DC=Contoso,DC=local</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Library</maml:name> <maml:description> <maml:para>The name of the library containing the page. If SitePages then please omit this parameter</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogFolder</maml:name> <maml:description> <maml:para>Folder in where the log file will be created (if LogType==File)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogSkipFlush</maml:name> <maml:description> <maml:para>By default each cmdlet invocation will result in a log file, use the -SkipLogFlush to delay the log flushing. The first call without -SkipLogFlush will then write all log entries to a single log</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogType</maml:name> <maml:description> <maml:para>Allows to generate a transformation log (File | SharePoint)</maml:para> </maml:description> <command:parameterValue required="false">ClientSidePageTransformatorLogType</command:parameterValue> <dev:type> <maml:name>ClientSidePageTransformatorLogType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogVerbose</maml:name> <maml:description> <maml:para>Configure logging to include verbose log entries</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrites page if already existing</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PageLayoutMapping</maml:name> <maml:description> <maml:para>Path and name of the page layout mapping file driving the publishing page transformation</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PostAsNews</maml:name> <maml:description> <maml:para>Post the created, and published, modern page as news</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishingPage</maml:name> <maml:description> <maml:para>I'm transforming a publishing page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishingTargetPageName</maml:name> <maml:description> <maml:para>Name for the target page (only applies to publishing page transformation)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveEmptySectionsAndColumns</maml:name> <maml:description> <maml:para>Remove empty sections and columns after transformation of the page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ReplaceHomePageWithDefault</maml:name> <maml:description> <maml:para>Replaces a home page with a default stock modern home page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetAuthorInPageHeader</maml:name> <maml:description> <maml:para>Set's the author of the source page as author in the modern page header (when source page lives in SPO)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipDefaultUrlRewriting</maml:name> <maml:description> <maml:para>Set this flag to prevent the default URL rewriting while you still want to do URL rewriting using a custom URL mapping file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipItemLevelPermissionCopyToClientSidePage</maml:name> <maml:description> <maml:para>By default the item level permissions on a page are copied to the created client side page. Use this switch to prevent the copy</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipTermStoreMapping</maml:name> <maml:description> <maml:para>Disables term mapping during transformation</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipUrlRewriting</maml:name> <maml:description> <maml:para>If transforming cross site then by default urls in html and summarylinks are rewritten for the target site. Set this flag to prevent that</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipUserMapping</maml:name> <maml:description> <maml:para>Disables user mapping during transformation</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SummaryLinksToHtml</maml:name> <maml:description> <maml:para>By default summarylinks web parts are replaced by QuickLinks, but you can transform to plain html by setting this switch</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TakeSourcePageName</maml:name> <maml:description> <maml:para>Created client side page takes name from previous classic page. Classic page gets renamed to previous_<Page>.aspx</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TargetConnection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TargetPageFolder</maml:name> <maml:description> <maml:para>Folder to create the target page in (will be used in conjunction with auto-generated folders that ensure page name uniqueness)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TargetPageFolderOverridesDefaultFolder</maml:name> <maml:description> <maml:para>When setting a target page folder then the target page folder overrides possibly default folder path (e.g. in the source page lived in a folder) instead of being appended to it</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TargetPageName</maml:name> <maml:description> <maml:para>Name for the target page (only applies when doing cross site page transformation)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TargetWebUrl</maml:name> <maml:description> <maml:para>Url of the target web that will receive the modern page. Defaults to null which means in-place transformation</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermMappingFile</maml:name> <maml:description> <maml:para>Specifies a taxonomy term mapping file</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UrlMappingFile</maml:name> <maml:description> <maml:para>File holding custom URL mapping definitions</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseCommunityScriptEditor</maml:name> <maml:description> <maml:para>Uses the community script editor (https://github.com/SharePoint/sp-dev-fx-webparts/tree/master/samples/react-script-editor) as replacement for the classic script editor web part</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserMappingFile</maml:name> <maml:description> <maml:para>Specifies a user mapping file</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebPartMappingFile</maml:name> <maml:description> <maml:para>Path and name of the web part mapping file driving the transformation</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -Overwrite</dev:code> <maml:remarks> <maml:para>Converts a wiki/web part page named 'somepage' to a client side page</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -Overwrite -WebPartMappingFile c:\contoso\webpartmapping.xml</dev:code> <maml:remarks> <maml:para>Converts a wiki/web part page named 'somepage' to a client side page using a custom provided mapping file</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -Overwrite -AddPageAcceptBanner</dev:code> <maml:remarks> <maml:para>Converts a wiki/web part page named 'somepage' to a client side page and adds the page accept banner web part on top of the page. This requires that the SPFX solution holding the web part (https://github.com/SharePoint/sp-dev-modernization/blob/master/Solutions/PageTransformationUI/assets/sharepointpnp-pagetransformation-client.sppkg?raw=true) has been installed to the tenant app catalog</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -Overwrite -CopyPageMetadata</dev:code> <maml:remarks> <maml:para>Converts a wiki/web part page named 'somepage' to a client side page, including the copying of the page metadata (if any)</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -PublishingPage -Overwrite -TargetWebUrl https://contoso.sharepoint.com/sites/targetmodernsite</dev:code> <maml:remarks> <maml:para>Converts a publishing page named 'somepage' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -PublishingPage -Overwrite -TargetConnection $target</dev:code> <maml:remarks> <maml:para>Converts a publishing page named 'somepage' to a client side page in the site specified by the TargetConnection connection. This allows to read a page in one environment (on-premises, tenant A) and create in another online location (tenant B)</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -Library "SiteAssets" -Folder "Folder1" -Overwrite</dev:code> <maml:remarks> <maml:para>Converts a web part page named 'somepage' living inside the SiteAssets library in a folder named folder1 into a client side page</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 8---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -Folder "<root>" -Overwrite</dev:code> <maml:remarks> <maml:para>Converts a web part page named 'somepage' living inside the root of the site collection (so outside of a library)</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 9---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -Overwrite -TargetWebUrl https://contoso.sharepoint.com/sites/targetmodernsite</dev:code> <maml:remarks> <maml:para>Converts a wiki/web part page named 'somepage' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 10---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -LogType File -LogFolder c:\temp -LogVerbose -Overwrite</dev:code> <maml:remarks> <maml:para>Converts a wiki/web part page named 'somepage' and creates a log file in c:\temp using verbose logging</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 11---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -LogType SharePoint -LogSkipFlush</dev:code> <maml:remarks> <maml:para>Converts a wiki/web part page named 'somepage' and creates a log file in SharePoint but skip the actual write. Use this option to make multiple ConvertTo-PnPClientSidePage invocations create a single log</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 12---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "My post title" -BlogPage -LogType Console -Overwrite -TargetWebUrl https://contoso.sharepoint.com/sites/targetmodernsite</dev:code> <maml:remarks> <maml:para>Converts a blog page with a title starting with 'my post title' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 13---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "My post title" -DelveBlogPage -LogType Console -Overwrite -TargetWebUrl https://contoso.sharepoint.com/sites/targetmodernsite</dev:code> <maml:remarks> <maml:para>Converts a Delve blog page with a title starting with 'my post title' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 14---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -PublishingPage -Overwrite -TargetConnection $target -UserMappingFile c:\\temp\user_mapping_file.csv</dev:code> <maml:remarks> <maml:para>Converts a publishing page named 'somepage' to a client side page in the site specified by the TargetConnection connection. This allows to read a page in on-premises environment and create in another online locations including using specific user mappings between the two environments.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Copy-PnPFile</command:name> <maml:description> <maml:para>Copies a file or folder to a different location, currently there is a 200MB file size limit for the file to be copied.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>PnPFile</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Copy-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>SourceUrl</maml:name> <maml:description> <maml:para>Site relative Url specifying the file or folder to copy.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>TargetUrl</maml:name> <maml:description> <maml:para>Server relative Url where to copy the file or folder to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteIfAlreadyExists</maml:name> <maml:description> <maml:para>If provided, if a file already exists at the TargetUrl, it will be overwritten. If omitted, the copy operation will be canceled if the file already exists at the TargetUrl location.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be requested and the action will be performed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipSourceFolderName</maml:name> <maml:description> <maml:para>If the source is a folder, the source folder name will not be created, only the contents within it.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be requested and the action will be performed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteIfAlreadyExists</maml:name> <maml:description> <maml:para>If provided, if a file already exists at the TargetUrl, it will be overwritten. If omitted, the copy operation will be canceled if the file already exists at the TargetUrl location.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipSourceFolderName</maml:name> <maml:description> <maml:para>If the source is a folder, the source folder name will not be created, only the contents within it.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SourceUrl</maml:name> <maml:description> <maml:para>Site relative Url specifying the file or folder to copy.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>TargetUrl</maml:name> <maml:description> <maml:para>Server relative Url where to copy the file or folder to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl /sites/otherproject/Documents/company.docx</dev:code> <maml:remarks> <maml:para>Copies a file named company.docx located in a document library called Documents in the current site to the site collection otherproject. If a file named company.docx already exists, it won't perform the copy.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl Documents/company2.docx</dev:code> <maml:remarks> <maml:para>Copies a file named company.docx located in a document library called Documents to a new document named company2.docx in the same library.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl Documents2/company.docx</dev:code> <maml:remarks> <maml:para>Copies a file named company.docx located in a document library called Documents to a document library called Documents2 in the same site. </maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl Subsite/Documents/company2.docx</dev:code> <maml:remarks> <maml:para>Copies a file named company.docx located in a document library called Documents to the document library named Document in a subsite named Subsite as a new document named company2.docx.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl Subsite/Documents</dev:code> <maml:remarks> <maml:para>Copies a file named company.docx located in a document library called Documents to the document library named Document in a subsite named Subsite keeping the file name.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl /sites/otherproject/Documents/company.docx -OverwriteIfAlreadyExists</dev:code> <maml:remarks> <maml:para>Copies a file named company.docx located in a document library called Documents in the current site to the site collection otherproject. If a file named company.docx already exists, it will still perform the copy and replace the original company.docx file.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Copy-PnPFile -SourceUrl Documents/MyDocs -TargetUrl /sites/otherproject/Documents -OverwriteIfAlreadyExists</dev:code> <maml:remarks> <maml:para>Copies a folder named MyDocs in the document library called Documents located in the current site to the site collection otherproject. If the MyDocs folder exist it will copy into it, if not it will be created.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 8---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Copy-PnPFile -SourceUrl Documents/MyDocs -TargetUrl /sites/otherproject/Documents -SkipSourceFolderName -OverwriteIfAlreadyExists</dev:code> <maml:remarks> <maml:para>Copies a folder named MyDocs in the document library called Documents located in the current site to the root folder of the library named Documents in the site collection otherproject.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 9---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Copy-PnPFile -SourceUrl Documents/MyDocs -TargetUrl /sites/otherproject/Documents/MyDocs -SkipSourceFolderName -OverwriteIfAlreadyExists</dev:code> <maml:remarks> <maml:para>Copies a folder named MyDocs in the MyDocs folder of the library named Documents. If the MyDocs folder does not exists, it will be created.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 10---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Copy-PnPFile -SourceUrl Documents/MyDocs -TargetUrl /sites/otherproject/Documents/MyDocs -OverwriteIfAlreadyExists</dev:code> <maml:remarks> <maml:para>Copies a folder named MyDocs in the root of the library named Documents. If the MyDocs folder exists in the target, a subfolder also named MyDocs is created.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 11---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Copy-PnPFile -SourceUrl SubSite1/Documents/company.docx -TargetUrl SubSite2/Documents</dev:code> <maml:remarks> <maml:para>Copies a file named company.docx in the library named Documents in SubSite1 to the library named Documents in SubSite2.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Deny-PnPTenantServicePrincipalPermissionRequest</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Denies a permission request for the current tenant's "SharePoint Online Client" service principal</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Deny</command:verb> <command:noun>PnPTenantServicePrincipalPermissionRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Denies a permission request for the current tenant's "SharePoint Online Client" service principal Denying a permission request removes that request from the list of permission requests.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Deny-PnPTenantServicePrincipalPermissionRequest</maml:name> <command:parameter required="true" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-PnPFeature</command:name> <maml:description> <maml:para>Disables a feature</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>PnPFeature</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Deactivates a feature that was active on a site</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-PnPFeature</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the feature to disable.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifies whether to continue if an error occurs when deactivating the feature.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specify the scope of the feature to deactivate, either Web or Site. Defaults to Web.</maml:para> </maml:description> <command:parameterValue required="true">FeatureScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifies whether to continue if an error occurs when deactivating the feature.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the feature to disable.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specify the scope of the feature to deactivate, either Web or Site. Defaults to Web.</maml:para> </maml:description> <command:parameterValue required="false">FeatureScope</command:parameterValue> <dev:type> <maml:name>FeatureScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>This will disable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Force</dev:code> <maml:remarks> <maml:para>This will disable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with force.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Web</dev:code> <maml:remarks> <maml:para>This will disable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with the web scope.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-PnPInPlaceRecordsManagementForSite</command:name> <maml:description> <maml:para>Disables in place records management for a site.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>PnPInPlaceRecordsManagementForSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Disable-PnPInPlaceRecordsManagementForSite</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Disable-PnPInPlaceRecordsManagementForSite</dev:code> <maml:remarks> <maml:para>The in place records management feature will be disabled</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-PnPPowerShellTelemetry</command:name> <maml:description> <maml:para>Disables PnP PowerShell telemetry tracking</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>PnPPowerShellTelemetry</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Disables PnP PowerShell telemetry tracking</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-PnPPowerShellTelemetry</maml:name> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Disable-PnPPowerShellTelemetry</dev:code> <maml:remarks> <maml:para>Will prompt you to confirm to disable telemetry tracking.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Disable-PnPPowerShellTelemetry -Force</dev:code> <maml:remarks> <maml:para>Will disable telemetry tracking without prompting.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-PnPResponsiveUI</command:name> <maml:description> <maml:para>Deactivate the PnP Response UI add-on</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>PnPResponsiveUI</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Disables the PnP Responsive UI implementation on a classic SharePoint Site</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-PnPResponsiveUI</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Disable-PnPResponsiveUI</dev:code> <maml:remarks> <maml:para>If enabled previously, this will remove the PnP Responsive UI from a site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-PnPSiteClassification</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Disables Site Classifications for the tenant. Requires a connection to the Microsoft Graph.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>PnPSiteClassification</command:noun> <dev:version /> </command:details> <command:syntax /> <command:parameters /> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" PS:> Disable-PnPSiteClassification</dev:code> <maml:remarks> <maml:para>Disables Site Classifications for your tenant.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-PnPTenantServicePrincipal</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Enables the current tenant's "SharePoint Online Client" service principal.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>PnPTenantServicePrincipal</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Enables the current tenant's "SharePoint Online Client" service principal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-PnPTenantServicePrincipal</maml:name> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disconnect-PnPOnline</command:name> <maml:description> <maml:para>Disconnects the context</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>PnPOnline</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Disconnects the current context and requires you to build up a new connection in order to use the Cmdlets again. Using Connect-PnPOnline to connect to a different site has the same effect.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-PnPOnline</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection to be used by cmdlet</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection to be used by cmdlet</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Disconnect-PnPOnline</dev:code> <maml:remarks> <maml:para>This will disconnect you from the server.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-PnPCommSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Enables the modern communication site experience on a classic team site.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>PnPCommSite</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command will enable the modern site experience on a classic team site. The site must be the root site of the site collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPCommSite</maml:name> <command:parameter required="false" position="named"> <maml:name>DesignPackageId</maml:name> <maml:description> <maml:para>The id (guid) of the design package to apply: 96c933ac-3698-44c7-9f4a-5fd17d71af9e (Topic = default), 6142d2a0-63a5-4ba0-aede-d9fefca2c767 (Showcase) or f6cc5403-0d63-442e-96c0-285923709ffc (Blank)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>DesignPackageId</maml:name> <maml:description> <maml:para>The id (guid) of the design package to apply: 96c933ac-3698-44c7-9f4a-5fd17d71af9e (Topic = default), 6142d2a0-63a5-4ba0-aede-d9fefca2c767 (Showcase) or f6cc5403-0d63-442e-96c0-285923709ffc (Blank)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Enable-PnPCommSite</dev:code> <maml:remarks> <maml:para>Enables the modern communication site experience on a classic team site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Enable-PnPCommSite -DesignPackageId 6142d2a0-63a5-4ba0-aede-d9fefca2c767</dev:code> <maml:remarks> <maml:para>Enables the modern communication site experience on a classic team site, allowing to specify the design package to be applied</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-PnPFeature</command:name> <maml:description> <maml:para>Enables a feature</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>PnPFeature</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPFeature</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the feature to enable.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifies whether to overwrite an existing feature with the same feature identifier. This parameter is ignored if there are no errors.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specify the scope of the feature to activate, either Web or Site. Defaults to Web.</maml:para> </maml:description> <command:parameterValue required="true">FeatureScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sandboxed</maml:name> <maml:description> <maml:para>Specify this parameter if the feature you're trying to activate is part of a sandboxed solution.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifies whether to overwrite an existing feature with the same feature identifier. This parameter is ignored if there are no errors.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the feature to enable.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sandboxed</maml:name> <maml:description> <maml:para>Specify this parameter if the feature you're trying to activate is part of a sandboxed solution.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Specify the scope of the feature to activate, either Web or Site. Defaults to Web.</maml:para> </maml:description> <command:parameterValue required="false">FeatureScope</command:parameterValue> <dev:type> <maml:name>FeatureScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Enable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Enable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Force</dev:code> <maml:remarks> <maml:para>This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with force.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Enable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Web</dev:code> <maml:remarks> <maml:para>This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with the web scope.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-PnPInPlaceRecordsManagementForSite</command:name> <maml:description> <maml:para>Enables in place records management for a site.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>PnPInPlaceRecordsManagementForSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPInPlaceRecordsManagementForSite</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Enable-PnPInPlaceRecordsManagementForSite</dev:code> <maml:remarks> <maml:para>The in place records management feature will be enabled and the in place record management will be enabled in all locations with record declaration allowed by all contributors and undeclaration by site admins</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-PnPPowerShellTelemetry</command:name> <maml:description> <maml:para>Enables PnP PowerShell telemetry tracking.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>PnPPowerShellTelemetry</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off, alternative, use the -NoTelemetry switch on Connect-PnPOnline to turn it off for that session.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPPowerShellTelemetry</maml:name> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Enable-PnPPowerShellTelemetry</dev:code> <maml:remarks> <maml:para>Will prompt you to confirm to enable telemetry tracking.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Enable-PnPPowerShellTelemetry -Force</dev:code> <maml:remarks> <maml:para>Will enable telemetry tracking without prompting.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-PnPResponsiveUI</command:name> <maml:description> <maml:para>Activates the PnP Response UI Add-on</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>PnPResponsiveUI</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Enables the PnP Responsive UI implementation on a classic SharePoint Site</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPResponsiveUI</maml:name> <command:parameter required="false" position="named"> <maml:name>InfrastructureSiteUrl</maml:name> <maml:description> <maml:para>A full URL pointing to an infrastructure site. If specified, it will add a custom action pointing to the responsive UI JS code in that site.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>InfrastructureSiteUrl</maml:name> <maml:description> <maml:para>A full URL pointing to an infrastructure site. If specified, it will add a custom action pointing to the responsive UI JS code in that site.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Enable-PnPResponsiveUI</dev:code> <maml:remarks> <maml:para>Will upload a CSS file, a JavaScript file and adds a custom action to the root web of the current site collection, enabling the responsive UI on the site collection. The CSS and JavaScript files are located in the style library, in a folder called SP.Responsive.UI.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-PnPSiteClassification</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Enables Site Classifications for the tenant. Requires a connection to the Microsoft Graph.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>PnPSiteClassification</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPSiteClassification</maml:name> <command:parameter required="true" position="named"> <maml:name>Classifications</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DefaultClassification</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsageGuidelinesUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Classifications</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DefaultClassification</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsageGuidelinesUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" PS:> Enable-PnPSiteClassification -Classifications "HBI","LBI","Top Secret" -DefaultClassification "LBI"</dev:code> <maml:remarks> <maml:para>Enables Site Classifications for your tenant and provides three classification values. The default value will be set to "LBI"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" PS:> Enable-PnPSiteClassification -Classifications "HBI","LBI","Top Secret" -UsageGuidelinesUrl https://aka.ms/sppnp</dev:code> <maml:remarks> <maml:para>Enables Site Classifications for your tenant and provides three classification values. The usage guideliness will be set to the specified URL.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-PnPTenantServicePrincipal</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Enables the current tenant's "SharePoint Online Client" service principal.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>PnPTenantServicePrincipal</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Enables the current tenant's "SharePoint Online Client" service principal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPTenantServicePrincipal</maml:name> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPProperty</command:name> <maml:description> <maml:para>Returns a previously not loaded property of a ClientObject</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPProperty</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Will populate properties of an object and optionally, if needed, load the value from the server. If one property is specified its value will be returned to the output.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>ClientObject</maml:name> <maml:description> <maml:para>Specifies the object where the properties of should be retrieved</maml:para> </maml:description> <command:parameterValue required="true">ClientObject</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Property</maml:name> <maml:description> <maml:para>The properties to load. If one property is specified its value will be returned to the output.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ClientObject</maml:name> <maml:description> <maml:para>Specifies the object where the properties of should be retrieved</maml:para> </maml:description> <command:parameterValue required="true">ClientObject</command:parameterValue> <dev:type> <maml:name>ClientObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Property</maml:name> <maml:description> <maml:para>The properties to load. If one property is specified its value will be returned to the output.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.ClientObject</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS:> $web = Get-PnPWeb PS:> Get-PnPProperty -ClientObject $web -Property Id, Lists PS:> $web.Lists</dev:code> <maml:remarks> <maml:para>Will load both the Id and Lists properties of the specified Web object.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS:> $list = Get-PnPList -Identity 'Site Assets' PS:> Get-PnPProperty -ClientObject $list -Property Views</dev:code> <maml:remarks> <maml:para>Will load the views object of the specified list object and return its value to the output.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-PnPClientSidePage</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Exports a Client Side Page to a PnP Provisioning Template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>PnPClientSidePage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPClientSidePage</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistBrandingFiles</maml:name> <maml:description> <maml:para>If specified referenced files will be exported to the current folder.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>If specified the template will be saved to the file specified with this parameter.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specify to override the question to overwrite a file if it already exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="true">ExtractConfigurationPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="false">ExtractConfigurationPipeBind</command:parameterValue> <dev:type> <maml:name>ExtractConfigurationPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specify to override the question to overwrite a file if it already exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> <dev:type> <maml:name>ClientSidePagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>If specified the template will be saved to the file specified with this parameter.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistBrandingFiles</maml:name> <maml:description> <maml:para>If specified referenced files will be exported to the current folder.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-PnPClientSidePage -Identity Home.aspx </dev:code> <maml:remarks> <maml:para>Exports the page 'Home.aspx' to a new PnP Provisioning Template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-PnPClientSidePageMapping</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Get's the built-in maping files or a custom mapping file for your publishing portal page layouts. These mapping files are used to tailor the page transformation experience.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>PnPClientSidePageMapping</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPClientSidePageMapping</maml:name> <command:parameter required="false" position="named"> <maml:name>BuiltInWebPartMapping</maml:name> <maml:description> <maml:para>Exports the builtin web part mapping file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BuiltInPageLayoutMapping</maml:name> <maml:description> <maml:para>Exports the builtin pagelayout mapping file (only needed for publishing page transformation)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomPageLayoutMapping</maml:name> <maml:description> <maml:para>Analyzes the pagelayouts in the current publishing portal and exports them as a pagelayout mapping file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AnalyzeOOBPageLayouts</maml:name> <maml:description> <maml:para>Set this flag if you also want to analyze the OOB page layouts...typically these are covered via the default mapping, but if you've updated these page layouts you might want to analyze them again</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder to created the mapping file(s) in</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrites existing mapping files</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Logging</maml:name> <maml:description> <maml:para>Outputs analyser logging to the console</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishingPage</maml:name> <maml:description> <maml:para>The name of the publishing page to export a page layout mapping file for</maml:para> </maml:description> <command:parameterValue required="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AnalyzeOOBPageLayouts</maml:name> <maml:description> <maml:para>Set this flag if you also want to analyze the OOB page layouts...typically these are covered via the default mapping, but if you've updated these page layouts you might want to analyze them again</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BuiltInPageLayoutMapping</maml:name> <maml:description> <maml:para>Exports the builtin pagelayout mapping file (only needed for publishing page transformation)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BuiltInWebPartMapping</maml:name> <maml:description> <maml:para>Exports the builtin web part mapping file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomPageLayoutMapping</maml:name> <maml:description> <maml:para>Analyzes the pagelayouts in the current publishing portal and exports them as a pagelayout mapping file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder to created the mapping file(s) in</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Logging</maml:name> <maml:description> <maml:para>Outputs analyser logging to the console</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrites existing mapping files</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishingPage</maml:name> <maml:description> <maml:para>The name of the publishing page to export a page layout mapping file for</maml:para> </maml:description> <command:parameterValue required="false">PagePipeBind</command:parameterValue> <dev:type> <maml:name>PagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-PnPClientSidePageMapping -BuiltInPageLayoutMapping -CustomPageLayoutMapping -Folder c:\\temp -Overwrite</dev:code> <maml:remarks> <maml:para>Exports the built in page layout mapping and analyzes the current site's page layouts and exports these to files in folder c:\temp</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-PnPClientSidePageMapping -CustomPageLayoutMapping -PublishingPage mypage.aspx -Folder c:\\temp -Overwrite</dev:code> <maml:remarks> <maml:para>Analyzes the page layout of page mypage.aspx and exports this to a file in folder c:\temp</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-PnPClientSidePageMapping -BuiltInWebPartMapping -Folder c:\\temp -Overwrite</dev:code> <maml:remarks> <maml:para>Exports the built in webpart mapping to a file in folder c:\temp. Use this a starting basis if you want to tailer the web part mapping behavior.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-PnPListToProvisioningTemplate</command:name> <maml:description> <maml:para>Exports one or more lists to provisioning template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>PnPListToProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPListToProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>Specify the lists to extract, either providing their ID or their Title.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OutputInstance</maml:name> <maml:description> <maml:para>Returns the template as an in-memory object, which is an instance of the ProvisioningTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Schema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="true">XMLPnPSchemaVersion</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>Specify the lists to extract, either providing their ID or their Title.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OutputInstance</maml:name> <maml:description> <maml:para>Returns the template as an in-memory object, which is an instance of the ProvisioningTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Schema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="false">XMLPnPSchemaVersion</command:parameterValue> <dev:type> <maml:name>XMLPnPSchemaVersion</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-PnPListToProvisioningTemplate -Out template.xml -List "Documents"</dev:code> <maml:remarks> <maml:para>Extracts a list to a new provisioning template including the list specified by title or ID.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-PnPListToProvisioningTemplate -Out template.pnp -List "Documents","Events"</dev:code> <maml:remarks> <maml:para>Extracts a list to a new provisioning template Office Open XML file, including the lists specified by title or ID.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-PnPTaxonomy</command:name> <maml:description> <maml:para>Exports a taxonomy to either the output or to a file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>PnPTaxonomy</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPTaxonomy</maml:name> <command:parameter required="false" position="named"> <maml:name>TermSetId</maml:name> <maml:description> <maml:para>If specified, will export the specified termset only</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to export; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>Specify the language code for the exported terms</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeID</maml:name> <maml:description> <maml:para>If specified will include the ids of the taxonomy items in the output. Format: <label>;#<guid></maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>File to export the data to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para>The path delimiter to be used, by default this is '|'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Defaults to Unicode</maml:para> </maml:description> <command:parameterValue required="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para>The path delimiter to be used, by default this is '|'</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Defaults to Unicode</maml:para> </maml:description> <command:parameterValue required="false">Encoding</command:parameterValue> <dev:type> <maml:name>Encoding</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeID</maml:name> <maml:description> <maml:para>If specified will include the ids of the taxonomy items in the output. Format: <label>;#<guid></maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>Specify the language code for the exported terms</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>File to export the data to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermSetId</maml:name> <maml:description> <maml:para>If specified, will export the specified termset only</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to export; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-PnPTaxonomy</dev:code> <maml:remarks> <maml:para>Exports the full taxonomy to the standard output</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-PnPTaxonomy -Path c:\output.txt</dev:code> <maml:remarks> <maml:para>Exports the full taxonomy the file output.txt</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-PnPTaxonomy -Path c:\output.txt -TermSetId f6f43025-7242-4f7a-b739-41fa32847254</dev:code> <maml:remarks> <maml:para>Exports the term set with the specified id</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-PnPTaxonomy -Path c:\output.txt -TermSetId f6f43025-7242-4f7a-b739-41fa32847254 -Lcid 1044</dev:code> <maml:remarks> <maml:para>Exports the term set with the specified id using Norwegian labels</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-PnPTermGroupToXml</command:name> <maml:description> <maml:para>Exports a taxonomy TermGroup to either the output or to an XML file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>PnPTermGroupToXml</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPTermGroupToXml</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or name of the termgroup</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TermGroup</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>File to export the data to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FullTemplate</maml:name> <maml:description> <maml:para>If specified, a full provisioning template structure will be returned</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Defaults to Unicode</maml:para> </maml:description> <command:parameterValue required="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Defaults to Unicode</maml:para> </maml:description> <command:parameterValue required="false">Encoding</command:parameterValue> <dev:type> <maml:name>Encoding</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FullTemplate</maml:name> <maml:description> <maml:para>If specified, a full provisioning template structure will be returned</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or name of the termgroup</maml:para> </maml:description> <command:parameterValue required="false">Id, Title or TermGroup</command:parameterValue> <dev:type> <maml:name>Id, Title or TermGroup</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>File to export the data to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-PnPTermGroupToXml</dev:code> <maml:remarks> <maml:para>Exports all term groups in the default site collection term store to the standard output</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-PnPTermGroupToXml -Out output.xml</dev:code> <maml:remarks> <maml:para>Exports all term groups in the default site collection term store to the file 'output.xml' in the current folder</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Export-PnPTermGroupToXml -Out c:\output.xml -Identity "Test Group"</dev:code> <maml:remarks> <maml:para>Exports the term group with the specified name to the file 'output.xml' located in the root folder of the C: drive.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $termgroup = Get-PnPTermGroup -GroupName Test PS:> $termgroup | Export-PnPTermGroupToXml -Out c:\output.xml</dev:code> <maml:remarks> <maml:para>Retrieves a termgroup and subsequently exports that term group to a the file named 'output.xml'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Find-PnPFile</command:name> <maml:description> <maml:para>Finds a file in the virtual file system of the web.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Find</command:verb> <command:noun>PnPFile</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Find-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>Wildcard query</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>List title, url or an actual List object to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>Wildcard query</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Folder object or relative url of a folder to query</maml:para> </maml:description> <command:parameterValue required="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>Wildcard query</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Folder object or relative url of a folder to query</maml:para> </maml:description> <command:parameterValue required="true">FolderPipeBind</command:parameterValue> <dev:type> <maml:name>FolderPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>List title, url or an actual List object to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>Wildcard query</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.File</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Find-PnPFile -Match *.master</dev:code> <maml:remarks> <maml:para>Will return all masterpages located in the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Find-PnPFile -List "Documents" -Match *.pdf</dev:code> <maml:remarks> <maml:para>Will return all pdf files located in given list.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Find-PnPFile -Folder "Shared Documents/Sub Folder" -Match *.docx</dev:code> <maml:remarks> <maml:para>Will return all docx files located in given folder.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPAlert</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Returns registered alerts for a user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPAlert</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAlert</maml:name> <command:parameter required="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User to retrieve the alerts for (User ID, login name or actual User object). Skip this parameter to retrieve the alerts for the current user. Note: Only site owners can retrieve alerts for other users.</maml:para> </maml:description> <command:parameterValue required="true">UserPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Retrieve alerts with this title. Title comparison is case sensitive.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Retrieve alerts with this title. Title comparison is case sensitive.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User to retrieve the alerts for (User ID, login name or actual User object). Skip this parameter to retrieve the alerts for the current user. Note: Only site owners can retrieve alerts for other users.</maml:para> </maml:description> <command:parameterValue required="false">UserPipeBind</command:parameterValue> <dev:type> <maml:name>UserPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAlert</dev:code> <maml:remarks> <maml:para>Returns all registered alerts for the current user</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAlert -List "Demo List"</dev:code> <maml:remarks> <maml:para>Returns all alerts registered on the given list for the current user.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAlert -List "Demo List" -User "i:0#.f|membership|Alice@contoso.onmicrosoft.com"</dev:code> <maml:remarks> <maml:para>Returns all alerts registered on the given list for the specified user.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAlert -Title "Demo Alert"</dev:code> <maml:remarks> <maml:para>Returns all alerts with the given title for the current user. Title comparison is case sensitive.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPApp</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Returns the available apps from the app catalog</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPApp</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPApp</maml:name> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="true">AppCatalogScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of an app which is available in the app catalog</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of an app which is available in the app catalog</maml:para> </maml:description> <command:parameterValue required="false">AppMetadataPipeBind</command:parameterValue> <dev:type> <maml:name>AppMetadataPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="false">AppCatalogScope</command:parameterValue> <dev:type> <maml:name>AppCatalogScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<OfficeDevPnP.Core.ALM.AppMetadata></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPApp</dev:code> <maml:remarks> <maml:para>This will return all available apps from the tenant app catalog. It will list the installed version in the current site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPApp -Scope Site</dev:code> <maml:remarks> <maml:para>This will return all available apps from the site collection scoped app catalog. It will list the installed version in the current site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPApp -Identity 2646ccc3-6a2b-46ef-9273-81411cbbb60f</dev:code> <maml:remarks> <maml:para>This will retrieve the specific app from the app catalog.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPAppInstance</command:name> <maml:description> <maml:para>Returns a SharePoint AddIn Instance</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPAppInstance</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns a SharePoint App/Addin that has been installed in the current site</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAppInstance</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the App Instance</maml:para> </maml:description> <command:parameterValue required="true">AppPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the App Instance</maml:para> </maml:description> <command:parameterValue required="false">AppPipeBind</command:parameterValue> <dev:type> <maml:name>AppPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<Microsoft.SharePoint.Client.AppInstance></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAppInstance</dev:code> <maml:remarks> <maml:para>This will return all addin instances in the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>This will return an addin instance with the specified id.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPApplicationCustomizer</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Returns all SharePoint Framework client side extension application customizers</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPApplicationCustomizer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns all SharePoint Framework client side extension application customizers registered on the current web and/or site</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPApplicationCustomizer</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the SharePoint Framework client side extension application customizer to return. Omit to return all SharePoint Frameworkclient side extension application customizer.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the SharePoint Framework client side extension application customizer, either Web, Site or All to return both (all is the default)</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThrowExceptionIfCustomActionNotFound</maml:name> <maml:description> <maml:para>Switch parameter if an exception should be thrown if the requested SharePoint Frameworkclient side extension application customizer does not exist (true) or if omitted, nothing will be returned in case the SharePoint Framework client side extension application customizer does not exist</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPApplicationCustomizer</maml:name> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the SharePoint Framework client side extension application customizer, either Web, Site or All to return both (all is the default)</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThrowExceptionIfCustomActionNotFound</maml:name> <maml:description> <maml:para>Switch parameter if an exception should be thrown if the requested SharePoint Frameworkclient side extension application customizer does not exist (true) or if omitted, nothing will be returned in case the SharePoint Framework client side extension application customizer does not exist</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPApplicationCustomizer</maml:name> <command:parameter required="true" position="named"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest for which existing custom action(s) should be removed</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the SharePoint Framework client side extension application customizer, either Web, Site or All to return both (all is the default)</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThrowExceptionIfCustomActionNotFound</maml:name> <maml:description> <maml:para>Switch parameter if an exception should be thrown if the requested SharePoint Frameworkclient side extension application customizer does not exist (true) or if omitted, nothing will be returned in case the SharePoint Framework client side extension application customizer does not exist</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest for which existing custom action(s) should be removed</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the SharePoint Framework client side extension application customizer to return. Omit to return all SharePoint Frameworkclient side extension application customizer.</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the SharePoint Framework client side extension application customizer, either Web, Site or All to return both (all is the default)</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThrowExceptionIfCustomActionNotFound</maml:name> <maml:description> <maml:para>Switch parameter if an exception should be thrown if the requested SharePoint Frameworkclient side extension application customizer does not exist (true) or if omitted, nothing will be returned in case the SharePoint Framework client side extension application customizer does not exist</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPApplicationCustomizer</dev:code> <maml:remarks> <maml:para>Returns the custom action representing the SharePoint Framework client side extension registrations registered on the current site collection and web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPApplicationCustomizer -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2</dev:code> <maml:remarks> <maml:para>Returns the custom action representing the SharePoint Framework client side extension registration with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPApplicationCustomizer -ClientSideComponentId aa66f67e-46c0-4474-8a82-42bf467d07f2 -Scope Web</dev:code> <maml:remarks> <maml:para>Returns the custom action(s) being registered for a SharePoint Framework solution having the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' in its manifest from the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPAuditing</command:name> <maml:description> <maml:para>Get the Auditing setting of a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPAuditing</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAuditing</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Audit</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAuditing</dev:code> <maml:remarks> <maml:para>Gets the auditing settings of the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPAuthenticationRealm</command:name> <maml:description> <maml:para>Returns the authentication realm</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPAuthenticationRealm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets the authentication realm for the current web</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAuthenticationRealm</maml:name> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAuthenticationRealm</dev:code> <maml:remarks> <maml:para>This will get the authentication realm for the current connected site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAuthenticationRealm -Url https://contoso.sharepoint.com</dev:code> <maml:remarks> <maml:para>This will get the authentication realm for https://contoso.sharepoint.com</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPAvailableClientSideComponents</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Gets the available client side components on a particular page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPAvailableClientSideComponents</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAvailableClientSideComponents</maml:name> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Component</maml:name> <maml:description> <maml:para>Specifies the component instance or Id to look for.</maml:para> </maml:description> <command:parameterValue required="true">ClientSideComponentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Component</maml:name> <maml:description> <maml:para>Specifies the component instance or Id to look for.</maml:para> </maml:description> <command:parameterValue required="false">ClientSideComponentPipeBind</command:parameterValue> <dev:type> <maml:name>ClientSideComponentPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> <dev:type> <maml:name>ClientSidePagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAvailableClientSideComponents -Page "MyPage.aspx"</dev:code> <maml:remarks> <maml:para>Gets the list of available client side components on the page 'MyPage.aspx'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAvailableClientSideComponents $page</dev:code> <maml:remarks> <maml:para>Gets the list of available client side components on the page contained in the $page variable</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAvailableClientSideComponents -Page "MyPage.aspx" -ComponentName "HelloWorld"</dev:code> <maml:remarks> <maml:para>Gets the client side component 'HelloWorld' if available on the page 'MyPage.aspx'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPClientSideComponent</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Retrieve one or more Client-Side components from a page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPClientSideComponent</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPClientSideComponent</maml:name> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>The instance id of the component</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>The instance id of the component</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> <dev:type> <maml:name>ClientSidePagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPClientSideComponent -Page Home</dev:code> <maml:remarks> <maml:para>Returns all controls defined on the given page.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82</dev:code> <maml:remarks> <maml:para>Returns a specific control defined on the given page.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPClientSidePage</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Gets a Client-Side Page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPClientSidePage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPClientSidePage</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> <dev:type> <maml:name>ClientSidePagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPClientSidePage -Identity "MyPage.aspx"</dev:code> <maml:remarks> <maml:para>Gets the Modern Page (Client-Side) named 'MyPage.aspx' in the current SharePoint site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPClientSidePage "MyPage"</dev:code> <maml:remarks> <maml:para>Gets the Modern Page (Client-Side) named 'MyPage.aspx' in the current SharePoint site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPClientSidePage "Templates/MyPageTemplate"</dev:code> <maml:remarks> <maml:para>Gets the Modern Page (Client-Side) named 'MyPageTemplate.aspx' from the templates folder of the Page Library in the current SharePoint site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPClientSidePage -Identity "MyPage.aspx" -Web (Get-PnPWeb -Identity "Subsite1")</dev:code> <maml:remarks> <maml:para>Gets the Modern Page (Client-Side) named 'MyPage.aspx' from the subsite named 'Subsite1'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPContentType</command:name> <maml:description> <maml:para>Retrieves a content type</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPContentType</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPContentType</maml:name> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>List to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InSiteHierarchy</maml:name> <maml:description> <maml:para>Search site hierarchy for content types</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Name or ID of the content type to retrieve</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Name or ID of the content type to retrieve</maml:para> </maml:description> <command:parameterValue required="false">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InSiteHierarchy</maml:name> <maml:description> <maml:para>Search site hierarchy for content types</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>List to query</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.ContentType</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPContentType </dev:code> <maml:remarks> <maml:para>This will get a listing of all available content types within the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPContentType -InSiteHierarchy</dev:code> <maml:remarks> <maml:para>This will get a listing of all available content types within the site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPContentType -Identity "Project Document"</dev:code> <maml:remarks> <maml:para>This will get the content type with the name "Project Document" within the current context</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPContentType -List "Documents"</dev:code> <maml:remarks> <maml:para>This will get a listing of all available content types within the list "Documents"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPContentTypePublishingHubUrl</command:name> <maml:description> <maml:para>Returns the url to Content Type Publishing Hub</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPContentTypePublishingHubUrl</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPContentTypePublishingHubUrl</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $url = Get-PnPContentTypePublishingHubUrl PS:> Connect-PnPOnline -Url $url PS:> Get-PnPContentType </dev:code> <maml:remarks> <maml:para>This will retrieve the url to the content type hub, connect to it, and then retrieve the content types form that site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPCustomAction</command:name> <maml:description> <maml:para>Return user custom actions</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPCustomAction</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns all or a specific user custom action</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPCustomAction</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the CustomAction to return. Omit to return all CustomActions.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the CustomAction, either Web, Site or All to return both</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThrowExceptionIfCustomActionNotFound</maml:name> <maml:description> <maml:para>Switch parameter if an exception should be thrown if the requested CustomAction does not exist (true) or if omitted, nothing will be returned in case the CustomAction does not exist</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the CustomAction to return. Omit to return all CustomActions.</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the CustomAction, either Web, Site or All to return both</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThrowExceptionIfCustomActionNotFound</maml:name> <maml:description> <maml:para>Switch parameter if an exception should be thrown if the requested CustomAction does not exist (true) or if omitted, nothing will be returned in case the CustomAction does not exist</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<Microsoft.SharePoint.Client.UserCustomAction></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPCustomAction</dev:code> <maml:remarks> <maml:para>Returns all custom actions of the current site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2</dev:code> <maml:remarks> <maml:para>Returns the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPCustomAction -Scope web</dev:code> <maml:remarks> <maml:para>Returns all custom actions for the current web object.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPDefaultColumnValues</command:name> <maml:description> <maml:para>Gets the default column values for all folders in document library</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPDefaultColumnValues</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets the default column values for a document library, per folder. Supports both text, people and taxonomy fields.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPDefaultColumnValues</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Name or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Name or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPDeletedUnifiedGroup</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Gets one deleted Office 365 Group (aka Unified Group) or a list of deleted Office 365 Groups</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPDeletedUnifiedGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPDeletedUnifiedGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="false">UnifiedGroupPipeBind</command:parameterValue> <dev:type> <maml:name>UnifiedGroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPDeletedUnifiedGroup</dev:code> <maml:remarks> <maml:para>Retrieves all deleted Office 365 Groups</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPDeletedUnifiedGroup -Identity 38b32e13-e900-4d95-b860-fb52bc07ca7f</dev:code> <maml:remarks> <maml:para>Retrieves a specific deleted Office 365 Group based on its ID</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPDocumentSetTemplate</command:name> <maml:description> <maml:para>Retrieves a document set template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPDocumentSetTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPDocumentSetTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Either specify a name, an id, a document set template object or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Either specify a name, an id, a document set template object or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> <dev:type> <maml:name>DocumentSetPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.DocumentSet.DocumentSetTemplate</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPDocumentSetTemplate -Identity "Test Document Set"</dev:code> <maml:remarks> <maml:para>This will get the document set template with the name "Test Document Set"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPDocumentSetTemplate -Identity "0x0120D520005DB65D094035A241BAC9AF083F825F3B"</dev:code> <maml:remarks> <maml:para>This will get the document set template with the id "0x0120D520005DB65D094035A241BAC9AF083F825F3B"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPEventReceiver</command:name> <maml:description> <maml:para>Return registered eventreceivers</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPEventReceiver</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns all registered or a specific eventreceiver</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPEventReceiver</maml:name> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object from which to get the event receiver object</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Guid of the event receiver</maml:para> </maml:description> <command:parameterValue required="true">EventReceiverPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPEventReceiver</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Guid of the event receiver</maml:para> </maml:description> <command:parameterValue required="true">EventReceiverPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Guid of the event receiver</maml:para> </maml:description> <command:parameterValue required="false">EventReceiverPipeBind</command:parameterValue> <dev:type> <maml:name>EventReceiverPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object from which to get the event receiver object</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.EventReceiverDefinition</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPEventReceiver</dev:code> <maml:remarks> <maml:para>This will return all registered event receivers on the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPEventReceiver -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22</dev:code> <maml:remarks> <maml:para>This will return the event receiver with the provided ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22" from the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPEventReceiver -Identity MyReceiver</dev:code> <maml:remarks> <maml:para>This will return the event receiver with the provided ReceiverName "MyReceiver" from the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPEventReceiver -List "ProjectList"</dev:code> <maml:remarks> <maml:para>This will return all registered event receivers in the provided "ProjectList" list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPEventReceiver -List "ProjectList" -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22</dev:code> <maml:remarks> <maml:para>This will return the event receiver in the provided "ProjectList" list with with the provided ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPEventReceiver -List "ProjectList" -Identity MyReceiver</dev:code> <maml:remarks> <maml:para>This will return the event receiver in the "ProjectList" list with the provided ReceiverName "MyReceiver"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPException</command:name> <maml:description> <maml:para>Returns the last exception that occurred</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPException</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns the last exception which can be used while debugging PnP Cmdlets</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPException</maml:name> <command:parameter required="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Show all exceptions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Show all exceptions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPException</dev:code> <maml:remarks> <maml:para>Returns the last exception</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPException -All</dev:code> <maml:remarks> <maml:para>Returns all exceptions that occurred</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPFeature</command:name> <maml:description> <maml:para>Returns all activated or a specific activated feature</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPFeature</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFeature</maml:name> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the feature. Defaults to Web.</maml:para> </maml:description> <command:parameterValue required="true">FeatureScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The feature ID or name to query for, Querying by name is not supported in version 15 of the Client Side Object Model</maml:para> </maml:description> <command:parameterValue required="true">FeaturePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The feature ID or name to query for, Querying by name is not supported in version 15 of the Client Side Object Model</maml:para> </maml:description> <command:parameterValue required="false">FeaturePipeBind</command:parameterValue> <dev:type> <maml:name>FeaturePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the feature. Defaults to Web.</maml:para> </maml:description> <command:parameterValue required="false">FeatureScope</command:parameterValue> <dev:type> <maml:name>FeatureScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<Microsoft.SharePoint.Client.Feature></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFeature</dev:code> <maml:remarks> <maml:para>This will return all activated web scoped features</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFeature -Scope Site</dev:code> <maml:remarks> <maml:para>This will return all activated site scoped features</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFeature -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22</dev:code> <maml:remarks> <maml:para>This will return a specific activated web scoped feature</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFeature -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 -Scope Site</dev:code> <maml:remarks> <maml:para>This will return a specific activated site scoped feature</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPField</command:name> <maml:description> <maml:para>Returns a field from a list or site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPField</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPField</maml:name> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where to get the field from</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>Filter to the specified group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InSiteHierarchy</maml:name> <maml:description> <maml:para>Search site hierarchy for fields</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The field object or name to get</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>Filter to the specified group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The field object or name to get</maml:para> </maml:description> <command:parameterValue required="false">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InSiteHierarchy</maml:name> <maml:description> <maml:para>Search site hierarchy for fields</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where to get the field from</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Field</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPField</dev:code> <maml:remarks> <maml:para>Gets all the fields from the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPField -List "Demo list" -Identity "Speakers"</dev:code> <maml:remarks> <maml:para>Gets the speakers field from the list Demo list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPFile</command:name> <maml:description> <maml:para>Downloads a file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPFile</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The URL (server or site relative) to the file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsFileObject</maml:name> <maml:description> <maml:para>Retrieve the file contents as a file object.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The URL (server or site relative) to the file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsListItem</maml:name> <maml:description> <maml:para>Returns the file as a listitem showing all its properties</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThrowExceptionIfFileNotFound</maml:name> <maml:description> <maml:para>If provided in combination with -AsListItem, a System.ArgumentException will be thrown if the file specified in the -Url argument does not exist. Otherwise it will return nothing instead.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The URL (server or site relative) to the file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsString</maml:name> <maml:description> <maml:para>Retrieve the file contents as a string</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>AsFile</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The URL (server or site relative) to the file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Local path where the file should be saved</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para>Name for the local file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>AsFile</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsFileObject</maml:name> <maml:description> <maml:para>Retrieve the file contents as a file object.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsListItem</maml:name> <maml:description> <maml:para>Returns the file as a listitem showing all its properties</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsString</maml:name> <maml:description> <maml:para>Retrieve the file contents as a string</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para>Name for the local file</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Local path where the file should be saved</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThrowExceptionIfFileNotFound</maml:name> <maml:description> <maml:para>If provided in combination with -AsListItem, a System.ArgumentException will be thrown if the file specified in the -Url argument does not exist. Otherwise it will return nothing instead.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The URL (server or site relative) to the file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.File</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor</dev:code> <maml:remarks> <maml:para>Retrieves the file and downloads it to the current folder</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -Path c:\temp -FileName company.spcolor -AsFile</dev:code> <maml:remarks> <maml:para>Retrieves the file and downloads it to c:\temp\company.spcolor</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsString</dev:code> <maml:remarks> <maml:para>Retrieves the file and outputs its contents to the console</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsFile</dev:code> <maml:remarks> <maml:para>Retrieves the file and returns it as a File object</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsListItem</dev:code> <maml:remarks> <maml:para>Retrieves the file and returns it as a ListItem object</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFile -Url _catalogs/themes/15/company.spcolor -Path c:\temp -FileName company.spcolor -AsFile</dev:code> <maml:remarks> <maml:para>Retrieves the file by site relative URL and downloads it to c:\temp\company.spcolor</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPFolder</command:name> <maml:description> <maml:para>Return a folder object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPFolder</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieves a folder if it exists or all folders inside a provided list or library. Use Resolve-PnPFolder to create the folder if it does not exist.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFolder</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Site or server relative URL of the folder to retrieve. In the case of a server relative url, make sure that the url starts with the managed path as the current web.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFolder</maml:name> <command:parameter required="true" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>Name, ID or instance of a list or document library to retrieve the folders residing in it for.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>Name, ID or instance of a list or document library to retrieve the folders residing in it for.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Site or server relative URL of the folder to retrieve. In the case of a server relative url, make sure that the url starts with the managed path as the current web.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Folder</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFolder -Url "Shared Documents"</dev:code> <maml:remarks> <maml:para>Returns the folder called 'Shared Documents' which is located in the root of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFolder -Url "/sites/demo/Shared Documents"</dev:code> <maml:remarks> <maml:para>Returns the folder called 'Shared Documents' which is located in the root of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFolder -List "Shared Documents"</dev:code> <maml:remarks> <maml:para>Returns the folder(s) residing inside a folder called 'Shared Documents'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resolve-PnPFolder:</maml:linkText> <maml:uri>https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/sharepoint/sharepoint-ps/sharepoint-pnp/Resolve-PnPFolder.md</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPFolderItem</command:name> <maml:description> <maml:para>List content in folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPFolderItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFolderItem</maml:name> <command:parameter required="false" position="named"> <maml:name>ItemType</maml:name> <maml:description> <maml:para>The type of contents to retrieve, either File, Folder or All (default)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Optional name of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FolderSiteRelativeUrl</maml:name> <maml:description> <maml:para>The site relative URL of the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>A switch parameter to include contents of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFolderItem</maml:name> <command:parameter required="false" position="named"> <maml:name>ItemType</maml:name> <maml:description> <maml:para>The type of contents to retrieve, either File, Folder or All (default)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Optional name of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A folder instance to the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>A switch parameter to include contents of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>FolderSiteRelativeUrl</maml:name> <maml:description> <maml:para>The site relative URL of the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A folder instance to the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="false">FolderPipeBind</command:parameterValue> <dev:type> <maml:name>FolderPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Optional name of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ItemType</maml:name> <maml:description> <maml:para>The type of contents to retrieve, either File, Folder or All (default)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>A switch parameter to include contents of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages"</dev:code> <maml:remarks> <maml:para>Returns the contents of the folder SitePages which is located in the root of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -ItemName "Default.aspx"</dev:code> <maml:remarks> <maml:para>Returns the file 'Default.aspx' which is located in the folder SitePages which is located in the root of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -ItemType Folder</dev:code> <maml:remarks> <maml:para>Returns all folders in the folder SitePages which is located in the root of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -ItemType File</dev:code> <maml:remarks> <maml:para>Returns all files in the folder SitePages which is located in the root of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -Recursive</dev:code> <maml:remarks> <maml:para>Returns all files and folders, including contents of any subfolders, in the folder SitePages which is located in the root of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPGroup</command:name> <maml:description> <maml:para>Returns a specific SharePoint group or all SharePoint groups in site.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get a specific group by name</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>AssociatedMemberGroup</maml:name> <maml:description> <maml:para>Retrieve the associated member group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>AssociatedVisitorGroup</maml:name> <maml:description> <maml:para>Retrieve the associated visitor group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>AssociatedOwnerGroup</maml:name> <maml:description> <maml:para>Retrieve the associated owner group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AssociatedMemberGroup</maml:name> <maml:description> <maml:para>Retrieve the associated member group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AssociatedOwnerGroup</maml:name> <maml:description> <maml:para>Retrieve the associated owner group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AssociatedVisitorGroup</maml:name> <maml:description> <maml:para>Retrieve the associated visitor group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get a specific group by name</maml:para> </maml:description> <command:parameterValue required="false">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<Microsoft.SharePoint.Client.Group></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPGroup</dev:code> <maml:remarks> <maml:para>Returns all SharePoint groups in a site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPGroup -Identity 'My Site Users'</dev:code> <maml:remarks> <maml:para>This will return the group called 'My Site Users' in if available in the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPGroup -AssociatedMemberGroup</dev:code> <maml:remarks> <maml:para>This will return the current members group for the site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPGroupMembers</command:name> <maml:description> <maml:para>Retrieves all members of a group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPGroupMembers</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command will return all the users that are a member of the provided SharePoint Group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPGroupMembers</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A group object, an ID or a name of a group</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A group object, an ID or a name of a group</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.User</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPGroupMembers -Identity 'Marketing Site Members'</dev:code> <maml:remarks> <maml:para>Returns all the users that are a member of the group 'Marketing Site Members' in the current sitecollection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPGroup | Get-PnPGroupMembers</dev:code> <maml:remarks> <maml:para>Returns all the users that are a member of any of the groups in the current sitecollection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPGroup | ? Title -Like 'Marketing*' | Get-PnPGroupMembers</dev:code> <maml:remarks> <maml:para>Returns all the users that are a member of any of the groups of which their name starts with the word 'Marketing' in the current sitecollection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPGroupPermissions</command:name> <maml:description> <maml:para>Returns the permissions for a specific SharePoint group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPGroupPermissions</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPGroupPermissions</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get the permissions of a specific group by name</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get the permissions of a specific group by name</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.RoleDefinitionBindingCollection</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPGroupPermissions -Identity 'My Site Members'</dev:code> <maml:remarks> <maml:para>Returns the permissions for the SharePoint group with the name 'My Site Members'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPHealthScore</command:name> <maml:description> <maml:para>* Supported in: SharePoint On-Premises. Retrieves the healthscore of the site given in his Url parameter or from the current connection if the Url parameter is not provided</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPHealthScore</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieves the current X-SharePointHealthScore value of the server, or CPU, on which your SharePoint instance runs. X-SharePointHealthScore is a value between 0 and 10, where 0 indicates the server is idle and 10 indicates the server is very busy. For more information visit https://docs.microsoft.com/office365/enterprise/diagnosing-performance-issues-with-sharepoint-online and https://docs.microsoft.com/openspecs/sharepoint_protocols/ms-wsshp/c60ddeb6-4113-4a73-9e97-26b5c3907d33.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> <maml:description> <maml:para>Returns a int value representing the current health score value of the server.</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPHealthScore</dev:code> <maml:remarks> <maml:para>This will retrieve the current health score of the server.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPHealthScore -Url https://contoso.sharepoint.com</dev:code> <maml:remarks> <maml:para>This will retrieve the current health score for the url https://contoso.sharepoint.com.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPHideDefaultThemes</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns if the default / OOTB themes should be visible to users or not.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPHideDefaultThemes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns if the default themes are visible. Use Set-PnPHideDefaultThemes to change this value. You must be a SharePoint Online global administrator to run the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPHideDefaultThemes</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPHideDefaultThemes</dev:code> <maml:remarks> <maml:para>This example returns the current setting if the default themes should be visible</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPHomePage</command:name> <maml:description> <maml:para>Return the homepage</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPHomePage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns the URL to the page set as home page</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPHomePage</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPHomePage</dev:code> <maml:remarks> <maml:para>Will return the URL of the home page of the web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPHomeSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns the home site url for your tenant</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPHomeSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPHomeSite</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPHomeSite</dev:code> <maml:remarks> <maml:para>Returns the home site url for your tenant</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPHubSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Retrieve all or a specific hubsite.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPHubSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPHubSite</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPHubSite</dev:code> <maml:remarks> <maml:para>Returns all hubsite properties</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPHubSite -Identity https://contoso.sharepoint.com/sites/myhubsite</dev:code> <maml:remarks> <maml:para>Returns the properties of the specified hubsite</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPHubSiteChild</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Retrieves all sites linked to a specific hub site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPHubSiteChild</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieves all sites linked to a specific hub site</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPHubSiteChild</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPHubChildSite -Identity https://contoso.sharepoint.com/sites/myhubsite</dev:code> <maml:remarks> <maml:para>Returns the sites having configured the provided hub site as their hub site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPIndexedPropertyKeys</command:name> <maml:description> <maml:para>Returns the keys of the property bag values that have been marked for indexing by search</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPIndexedPropertyKeys</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPIndexedPropertyKeys</maml:name> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name from where to get the indexed properties</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name from where to get the indexed properties</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPInPlaceRecordsManagement</command:name> <maml:description> <maml:para>Returns if the place records management feature is enabled.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPInPlaceRecordsManagement</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPInPlaceRecordsManagement</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPInPlaceRecordsManagement</dev:code> <maml:remarks> <maml:para>Returns if $true if in place records management is active</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPJavaScriptLink</command:name> <maml:description> <maml:para>Returns all or a specific custom action(s) with location type ScriptLink</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPJavaScriptLink</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPJavaScriptLink</maml:name> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the action, either Web, Site or All to return both, defaults to Web</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThrowExceptionIfJavaScriptLinkNotFound</maml:name> <maml:description> <maml:para>Switch parameter if an exception should be thrown if the requested JavaScriptLink does not exist (true) or if omitted, nothing will be returned in case the JavaScriptLink does not exist</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Javascript link. Omit this parameter to retrieve all script links</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Javascript link. Omit this parameter to retrieve all script links</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the action, either Web, Site or All to return both, defaults to Web</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThrowExceptionIfJavaScriptLinkNotFound</maml:name> <maml:description> <maml:para>Switch parameter if an exception should be thrown if the requested JavaScriptLink does not exist (true) or if omitted, nothing will be returned in case the JavaScriptLink does not exist</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.UserCustomAction</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPJavaScriptLink</dev:code> <maml:remarks> <maml:para>Returns all web scoped JavaScript links</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPJavaScriptLink -Scope All</dev:code> <maml:remarks> <maml:para>Returns all web and site scoped JavaScript links</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPJavaScriptLink -Scope Web</dev:code> <maml:remarks> <maml:para>Returns all Web scoped JavaScript links</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPJavaScriptLink -Scope Site</dev:code> <maml:remarks> <maml:para>Returns all Site scoped JavaScript links</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPJavaScriptLink -Name Test</dev:code> <maml:remarks> <maml:para>Returns the web scoped JavaScript link named Test</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPLabel</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Gets the Office 365 retention label/tag of the specified list or library (if applicable)</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPLabel</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPLabel</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPLabel -List "Demo List"</dev:code> <maml:remarks> <maml:para>This gets the Office 365 retention label which is set to a list or a library.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPList</command:name> <maml:description> <maml:para>Returns a List object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPList</maml:name> <command:parameter required="false" position="named"> <maml:name>ThrowExceptionIfListNotFound</maml:name> <maml:description> <maml:para>Switch parameter if an exception should be thrown if the requested list does not exist (true) or if omitted, nothing will be returned in case the list does not exist</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID, name or Url (Lists/MyList) of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID, name or Url (Lists/MyList) of the list.</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThrowExceptionIfListNotFound</maml:name> <maml:description> <maml:para>Switch parameter if an exception should be thrown if the requested list does not exist (true) or if omitted, nothing will be returned in case the list does not exist</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.List</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPList</dev:code> <maml:remarks> <maml:para>Returns all lists in the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPList -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>Returns a list with the given id.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPList -Identity Lists/Announcements</dev:code> <maml:remarks> <maml:para>Returns a list with the given url.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPListInformationRightsManagement</command:name> <maml:description> <maml:para>Get the site closure status of the site which has a site policy applied</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPListInformationRightsManagement</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPListInformationRightsManagement</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPListInformationRightsManagement -List "Documents"</dev:code> <maml:remarks> <maml:para>Returns Information Rights Management (IRM) settings for the list. See 'Get-Help Set-PnPListInformationRightsManagement -Detailed' for more information about the various values.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPListItem</command:name> <maml:description> <maml:para>Retrieves list items</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPListItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPListItem</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>The fields to retrieve. If not specified all fields will be loaded in the returned list object.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPListItem</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UniqueId</maml:name> <maml:description> <maml:para>The unique id (GUID) of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>The fields to retrieve. If not specified all fields will be loaded in the returned list object.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPListItem</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>The CAML query to execute against the list</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>The number of items to retrieve per page request.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScriptBlock</maml:name> <maml:description> <maml:para>The script block to run after every page request.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPListItem</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>The fields to retrieve. If not specified all fields will be loaded in the returned list object.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>The number of items to retrieve per page request.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScriptBlock</maml:name> <maml:description> <maml:para>The script block to run after every page request.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>The fields to retrieve. If not specified all fields will be loaded in the returned list object.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>The number of items to retrieve per page request.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>The CAML query to execute against the list</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ScriptBlock</maml:name> <maml:description> <maml:para>The script block to run after every page request.</maml:para> </maml:description> <command:parameterValue required="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UniqueId</maml:name> <maml:description> <maml:para>The unique id (GUID) of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.ListItem</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPListItem -List Tasks</dev:code> <maml:remarks> <maml:para>Retrieves all list items from the Tasks list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPListItem -List Tasks -Id 1</dev:code> <maml:remarks> <maml:para>Retrieves the list item with ID 1 from the Tasks list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPListItem -List Tasks -UniqueId bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3</dev:code> <maml:remarks> <maml:para>Retrieves the list item with unique id bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3 from the tasks lists</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> (Get-PnPListItem -List Tasks -Fields "Title","GUID").FieldValues</dev:code> <maml:remarks> <maml:para>Retrieves all list items, but only includes the values of the Title and GUID fields in the list item object</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPListItem -List Tasks -Query "<View><Query><Where><Eq><FieldRef Name='GUID'/><Value Type='Guid'>bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3</Value></Eq></Where></Query></View>"</dev:code> <maml:remarks> <maml:para>Retrieves all list items based on the CAML query specified</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPListItem -List Tasks -PageSize 1000</dev:code> <maml:remarks> <maml:para>Retrieves all list items from the Tasks list in pages of 1000 items</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPListItem -List Tasks -PageSize 1000 -ScriptBlock { Param($items) $items.Context.ExecuteQuery() } | % { $_.BreakRoleInheritance($true, $true) }</dev:code> <maml:remarks> <maml:para>Retrieves all list items from the Tasks list in pages of 1000 items and breaks permission inheritance on each item</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPListRecordDeclaration</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns the manual record declaration settings for a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPListRecordDeclaration</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPListRecordDeclaration</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to retrieve the record declaration settings for</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to retrieve the record declaration settings for</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPListRecordDeclaration -List "Documents"</dev:code> <maml:remarks> <maml:para>Returns the record declaration setting for the list "Documents"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPManagementApiAccessToken</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Gets an access token for the Office 365 Management API</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPManagementApiAccessToken</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPManagementApiAccessToken</maml:name> <command:parameter required="true" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The Tenant ID to connect to the Office 365 Management API</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The App\Client ID of the app which gives you access to the Office 365 Management API</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>The Client Secret of the app which gives you access to the Office 365 Management API</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The App\Client ID of the app which gives you access to the Office 365 Management API</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>The Client Secret of the app which gives you access to the Office 365 Management API</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The Tenant ID to connect to the Office 365 Management API</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPManagementApiAccessToken -TenantId $tenantId -ClientId $clientId -ClientSecret $clientSecret)</dev:code> <maml:remarks> <maml:para>Retrieves access token for the Office 365 Management API</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -AccessToken (Get-PnPManagementApiAccessToken -TenantId $tenantId -ClientId $clientId -ClientSecret $clientSecret)</dev:code> <maml:remarks> <maml:para>Connects to the Office 365 Management API using an access token for the Office 365 Management API</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPMasterPage</command:name> <maml:description> <maml:para>Returns the URLs of the default Master Page and the custom Master Page.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPMasterPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPMasterPage</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPNavigationNode</command:name> <maml:description> <maml:para>Returns all or a specific navigation node</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPNavigationNode</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPNavigationNode</maml:name> <command:parameter required="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location of the nodes to retrieve. Either TopNavigationBar, QuickLaunch</maml:para> </maml:description> <command:parameterValue required="true">NavigationType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Tree</maml:name> <maml:description> <maml:para>Show a tree view of all navigation nodes</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPNavigationNode</maml:name> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the node to retrieve</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Tree</maml:name> <maml:description> <maml:para>Show a tree view of all navigation nodes</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the node to retrieve</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location of the nodes to retrieve. Either TopNavigationBar, QuickLaunch</maml:para> </maml:description> <command:parameterValue required="false">NavigationType</command:parameterValue> <dev:type> <maml:name>NavigationType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Tree</maml:name> <maml:description> <maml:para>Show a tree view of all navigation nodes</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPNavigationNode</dev:code> <maml:remarks> <maml:para>Returns all navigation nodes in the quicklaunch navigation</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPNavigationNode -Location QuickLaunch</dev:code> <maml:remarks> <maml:para>Returns all navigation nodes in the quicklaunch navigation</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPNavigationNode -Location TopNavigationBar</dev:code> <maml:remarks> <maml:para>Returns all navigation nodes in the top navigation bar</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $node = Get-PnPNavigationNode -Id 2030 PS> $children = $node.Children</dev:code> <maml:remarks> <maml:para>Returns the selected navigation node and retrieves any children</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPOrgAssetsLibrary</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns the list of all the configured organizational asset libraries</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPOrgAssetsLibrary</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPOrgAssetsLibrary</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPOrgAssetsLibrary</dev:code> <maml:remarks> <maml:para>Returns the list of all the configured organizational asset sites</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> (Get-PnPOrgAssetsLibrary)[0].OrgAssetsLibraries[0].LibraryUrl.DecodedUrl</dev:code> <maml:remarks> <maml:para>Returns the server relative url of the first document library which has been flagged as organizational asset library, i.e. "sites/branding/logos"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPOrgNewsSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns the list of all the configured organizational news sites.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPOrgNewsSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPOrgNewsSite</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPOrgNewsSite</dev:code> <maml:remarks> <maml:para>Returns the list of all the configured organizational news sites.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPAccessToken</command:name> <maml:description> <maml:para>Returns the current OAuth Access token</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPAccessToken</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets the OAuth 2.0 Access Token to consume the Microsoft Graph API</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAccessToken</maml:name> <command:parameter required="false" position="named"> <maml:name>Decoded</maml:name> <maml:description> <maml:para>Returns the access token in a decoded manner</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Decoded</maml:name> <maml:description> <maml:para>Returns the access token in a decoded manner</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAccessToken</dev:code> <maml:remarks> <maml:para>Gets the OAuth 2.0 Access Token to consume the Microsoft Graph API</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPAzureCertificate</command:name> <maml:description> <maml:para>Get PEM values and manifest settings for an existing certificate (.pfx) for use when using CSOM via an app-only ADAL application. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. KeyCredentials contains the ADAL app manifest sections. Certificate contains the PEM encoded certificate. PrivateKey contains the PEM encoded private key of the certificate.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPAzureCertificate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureCertificate</maml:name> <command:parameter required="true" position="named"> <maml:name>CertificatePath</maml:name> <maml:description> <maml:para>Path to the certificate (*.pfx)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CertificatePassword</maml:name> <maml:description> <maml:para>Password to the certificate (*.pfx)</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>CertificatePassword</maml:name> <maml:description> <maml:para>Password to the certificate (*.pfx)</maml:para> </maml:description> <command:parameterValue required="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>CertificatePath</maml:name> <maml:description> <maml:para>Path to the certificate (*.pfx)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAzureCertificate -CertificatePath "mycert.pfx"</dev:code> <maml:remarks> <maml:para>This will output PEM values and ADAL app manifest settings for the certificate mycert.pfx.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAzureCertificate -CertificatePath "mycert.pfx" -CertificatePassword (ConvertTo-SecureString -String "YourPassword" -AsPlainText -Force)</dev:code> <maml:remarks> <maml:para>This will output PEM values and ADAL app manifest settings for the certificate mycert.pfx which has the password YourPassword.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPAzureCertificate -CertificatePath "mycert.cer" | clip</dev:code> <maml:remarks> <maml:para>Output the JSON snippet which needs to be replaced in the application manifest file and copies it to the clipboard</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPAppAuthAccessToken</command:name> <maml:description> <maml:para>Returns the access token</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPAppAuthAccessToken</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns the access token from the current client context (only works with App-Only authentication)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAppAuthAccessToken</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $accessToken = Get-PnPAppAuthAccessToken</dev:code> <maml:remarks> <maml:para>This will put the access token from current context in the $accessToken variable. Will only work in App authentication flow (App+user or App-Only)</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPConnection</command:name> <maml:description> <maml:para>Returns the current context</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPConnection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns a PnP PowerShell Connection for use with the -Connection parameter on other cmdlets.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $ctx = Get-PnPConnection</dev:code> <maml:remarks> <maml:para>This will put the current connection for use with the -Connection parameter on other cmdlets.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSiteCollectionTermStore</command:name> <maml:description> <maml:para>Returns the site collection term store</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSiteCollectionTermStore</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteCollectionTermStore</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Taxonomy.TermStore</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteCollectionTermStore</dev:code> <maml:remarks> <maml:para>Returns the site collection term store.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPStorageEntity</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Retrieve Storage Entities / Farm Properties from either the Tenant App Catalog or from the current site if it has a site scope app catalog.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPStorageEntity</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPStorageEntity</maml:name> <command:parameter required="false" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the value to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines the scope of the storage entity. Defaults to Tenant.</maml:para> </maml:description> <command:parameterValue required="true">StorageEntityScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the value to retrieve.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines the scope of the storage entity. Defaults to Tenant.</maml:para> </maml:description> <command:parameterValue required="false">StorageEntityScope</command:parameterValue> <dev:type> <maml:name>StorageEntityScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPStorageEntity</dev:code> <maml:remarks> <maml:para>Returns all site storage entities/farm properties</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPStorageEntity -Key MyKey</dev:code> <maml:remarks> <maml:para>Returns the storage entity/farm property with the given key.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPStorageEntity -Scope Site</dev:code> <maml:remarks> <maml:para>Returns all site collection scoped storage entities</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPStorageEntity -Key MyKey -Scope Site</dev:code> <maml:remarks> <maml:para>Returns the storage entity from the site collection with the given key</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPPowerShellTelemetryEnabled</command:name> <maml:description> <maml:para>Returns true if the PnP PowerShell Telemetry has been enabled.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPPowerShellTelemetryEnabled</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. We track the version of the cmdlets you are using, which cmdlet you are executing and which version of SharePoint you are connecting to. Use Disable-PnPPowerShellTelemetry to turn this off, alternative, use the -NoTelemetry switch on Connect-PnPOnline to turn it off for that session.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPowerShellTelemetryEnabled</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPPowerShellTelemetryEnabled</dev:code> <maml:remarks> <maml:para>Will return true of false.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPPropertyBag</command:name> <maml:description> <maml:para>Returns the property bag values.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPPropertyBag</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPropertyBag</maml:name> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site relative url of the folder. See examples for use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key that should be looked up</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site relative url of the folder. See examples for use.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key that should be looked up</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SharePointPnP.PowerShell.Commands.PropertyBagValue</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPPropertyBag</dev:code> <maml:remarks> <maml:para>This will return all web property bag values</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPPropertyBag -Key MyKey</dev:code> <maml:remarks> <maml:para>This will return the value of the key MyKey from the web property bag</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPPropertyBag -Folder /MyFolder</dev:code> <maml:remarks> <maml:para>This will return all property bag values for the folder MyFolder which is located in the root of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPPropertyBag -Folder /MyFolder -Key vti_mykey</dev:code> <maml:remarks> <maml:para>This will return the value of the key vti_mykey from the folder MyFolder which is located in the root of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPPropertyBag -Folder / -Key vti_mykey</dev:code> <maml:remarks> <maml:para>This will return the value of the key vti_mykey from the root folder of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPProvisioningTemplate</command:name> <maml:description> <maml:para>Generates a provisioning site template from a web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPProvisioningTemplate</maml:name> <command:parameter required="false" position="named"> <maml:name>IncludeAllTermGroups</maml:name> <maml:description> <maml:para>If specified, all term groups will be included. Overrides IncludeSiteCollectionTermGroup.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSiteCollectionTermGroup</maml:name> <maml:description> <maml:para>If specified, all the site collection term groups will be included. Overridden by IncludeAllTermGroups.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSiteGroups</maml:name> <maml:description> <maml:para>If specified all site groups will be included.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeTermGroupsSecurity</maml:name> <maml:description> <maml:para>If specified all the managers and contributors of term groups will be included.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSearchConfiguration</maml:name> <maml:description> <maml:para>If specified the template will contain the current search configuration of the site.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistBrandingFiles</maml:name> <maml:description> <maml:para>If specified the files used for masterpages, sitelogo, alternate CSS and the files that make up the composed look will be saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistPublishingFiles</maml:name> <maml:description> <maml:para>If specified the files used for the publishing feature will be saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeNativePublishingFiles</maml:name> <maml:description> <maml:para>If specified, out of the box / native publishing files will be saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeHiddenLists</maml:name> <maml:description> <maml:para>If specified hidden lists will be included in the template</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAllClientSidePages</maml:name> <maml:description> <maml:para>If specified all client side pages will be included</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipVersionCheck</maml:name> <maml:description> <maml:para>During extraction the version of the server will be checked for certain actions. If you specify this switch, this check will be skipped.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistMultiLanguageResources</maml:name> <maml:description> <maml:para>If specified, resource values for applicable artifacts will be persisted to a resource file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceFilePrefix</maml:name> <maml:description> <maml:para>If specified, resource files will be saved with the specified prefix instead of using the template name specified. If no template name is specified the files will be called PnP-Resources.<language>.resx. See examples for more info.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Handlers</maml:name> <maml:description> <maml:para>Allows you to only process a specific type of artifact in the site. Notice that this might result in a non-working template, as some of the handlers require other artifacts in place if they are not part of what your extracting. For possible values for this parameter visit https://docs.microsoft.com/dotnet/api/officedevpnp.core.framework.provisioning.model.handlers</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeHandlers</maml:name> <maml:description> <maml:para>Allows you to run all handlers, excluding the ones specified.</maml:para> </maml:description> <command:parameterValue required="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExtensibilityHandlers</maml:name> <maml:description> <maml:para>Allows you to specify ExtensibilityHandlers to execute while extracting a template.</maml:para> </maml:description> <command:parameterValue required="true">ExtensibilityHandler[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while extracting a template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentTypeGroups</maml:name> <maml:description> <maml:para>Allows you to specify from which content type group(s) the content types should be included into the template.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>The encoding type of the XML file, Unicode is default</maml:para> </maml:description> <command:parameterValue required="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateDisplayName</maml:name> <maml:description> <maml:para>It can be used to specify the DisplayName of the template file that will be extracted.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateImagePreviewUrl</maml:name> <maml:description> <maml:para>It can be used to specify the ImagePreviewUrl of the template file that will be extracted.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProperties</maml:name> <maml:description> <maml:para>It can be used to specify custom Properties for the template file that will be extracted.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OutputInstance</maml:name> <maml:description> <maml:para>Returns the template as an in-memory object, which is an instance of the ProvisioningTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeContentTypesFromSyndication</maml:name> <maml:description> <maml:para>Specify whether or not content types issued from a content hub should be exported. By default, these content types are included.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListsToExtract</maml:name> <maml:description> <maml:para>Specify the lists to extract, either providing their ID or their Title.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="true">ExtractConfigurationPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Schema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="true">XMLPnPSchemaVersion</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="false">ExtractConfigurationPipeBind</command:parameterValue> <dev:type> <maml:name>ExtractConfigurationPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentTypeGroups</maml:name> <maml:description> <maml:para>Allows you to specify from which content type group(s) the content types should be included into the template.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>The encoding type of the XML file, Unicode is default</maml:para> </maml:description> <command:parameterValue required="false">Encoding</command:parameterValue> <dev:type> <maml:name>Encoding</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeContentTypesFromSyndication</maml:name> <maml:description> <maml:para>Specify whether or not content types issued from a content hub should be exported. By default, these content types are included.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeHandlers</maml:name> <maml:description> <maml:para>Allows you to run all handlers, excluding the ones specified.</maml:para> </maml:description> <command:parameterValue required="false">Handlers</command:parameterValue> <dev:type> <maml:name>Handlers</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExtensibilityHandlers</maml:name> <maml:description> <maml:para>Allows you to specify ExtensibilityHandlers to execute while extracting a template.</maml:para> </maml:description> <command:parameterValue required="false">ExtensibilityHandler[]</command:parameterValue> <dev:type> <maml:name>ExtensibilityHandler[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Handlers</maml:name> <maml:description> <maml:para>Allows you to only process a specific type of artifact in the site. Notice that this might result in a non-working template, as some of the handlers require other artifacts in place if they are not part of what your extracting. For possible values for this parameter visit https://docs.microsoft.com/dotnet/api/officedevpnp.core.framework.provisioning.model.handlers</maml:para> </maml:description> <command:parameterValue required="false">Handlers</command:parameterValue> <dev:type> <maml:name>Handlers</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAllClientSidePages</maml:name> <maml:description> <maml:para>If specified all client side pages will be included</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAllTermGroups</maml:name> <maml:description> <maml:para>If specified, all term groups will be included. Overrides IncludeSiteCollectionTermGroup.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeHiddenLists</maml:name> <maml:description> <maml:para>If specified hidden lists will be included in the template</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeNativePublishingFiles</maml:name> <maml:description> <maml:para>If specified, out of the box / native publishing files will be saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSearchConfiguration</maml:name> <maml:description> <maml:para>If specified the template will contain the current search configuration of the site.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSiteCollectionTermGroup</maml:name> <maml:description> <maml:para>If specified, all the site collection term groups will be included. Overridden by IncludeAllTermGroups.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSiteGroups</maml:name> <maml:description> <maml:para>If specified all site groups will be included.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeTermGroupsSecurity</maml:name> <maml:description> <maml:para>If specified all the managers and contributors of term groups will be included.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListsToExtract</maml:name> <maml:description> <maml:para>Specify the lists to extract, either providing their ID or their Title.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OutputInstance</maml:name> <maml:description> <maml:para>Returns the template as an in-memory object, which is an instance of the ProvisioningTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistBrandingFiles</maml:name> <maml:description> <maml:para>If specified the files used for masterpages, sitelogo, alternate CSS and the files that make up the composed look will be saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistMultiLanguageResources</maml:name> <maml:description> <maml:para>If specified, resource values for applicable artifacts will be persisted to a resource file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PersistPublishingFiles</maml:name> <maml:description> <maml:para>If specified the files used for the publishing feature will be saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceFilePrefix</maml:name> <maml:description> <maml:para>If specified, resource files will be saved with the specified prefix instead of using the template name specified. If no template name is specified the files will be called PnP-Resources.<language>.resx. See examples for more info.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Schema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="false">XMLPnPSchemaVersion</command:parameterValue> <dev:type> <maml:name>XMLPnPSchemaVersion</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipVersionCheck</maml:name> <maml:description> <maml:para>During extraction the version of the server will be checked for certain actions. If you specify this switch, this check will be skipped.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateDisplayName</maml:name> <maml:description> <maml:para>It can be used to specify the DisplayName of the template file that will be extracted.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateImagePreviewUrl</maml:name> <maml:description> <maml:para>It can be used to specify the ImagePreviewUrl of the template file that will be extracted.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProperties</maml:name> <maml:description> <maml:para>It can be used to specify custom Properties for the template file that will be extracted.</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while extracting a template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPProvisioningTemplate -Out template.pnp</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPProvisioningTemplate -Out template.xml</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in XML format from the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPProvisioningTemplate -Out template.pnp -Schema V201503</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web and saves it in the V201503 version of the schema.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPProvisioningTemplate -Out template.pnp -IncludeAllTermGroups</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web and includes all term groups, term sets and terms from the Managed Metadata Service Taxonomy.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPProvisioningTemplate -Out template.pnp -IncludeSiteCollectionTermGroup</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web and includes the term group currently (if set) assigned to the site collection.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPProvisioningTemplate -Out template.pnp -PersistComposedLookFiles</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web and saves the files that make up the composed look to the same folder as where the template is saved.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPProvisioningTemplate -Out template.pnp -Handlers Lists, SiteSecurity</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web, but only processes lists and site security when generating the template.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 8---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS:> $handler1 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 PS:> $handler2 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler2 PS:> Get-PnPProvisioningTemplate -Out NewTemplate.xml -ExtensibilityHandlers $handler1,$handler2</dev:code> <maml:remarks> <maml:para>This will create two new ExtensibilityHandler objects that are run during extraction of the template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 9---------------------</maml:title> <maml:introduction> <maml:para>Only supported on SP2016, SP2019 and SP Online</maml:para> </maml:introduction> <dev:code>PS:> Get-PnPProvisioningTemplate -Out template.pnp -PersistMultiLanguageResources</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web, and for supported artifacts it will create a resource file for each supported language (based upon the language settings of the current web). The generated resource files will be named after the value specified in the Out parameter. For instance if the Out parameter is specified as -Out 'template.xml' the generated resource file will be called 'template.en-US.resx'.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 10---------------------</maml:title> <maml:introduction> <maml:para>Only supported on SP2016, SP2019 and SP Online</maml:para> </maml:introduction> <dev:code>PS:> Get-PnPProvisioningTemplate -Out template.pnp -PersistMultiLanguageResources -ResourceFilePrefix MyResources</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web, and for supported artifacts it will create a resource file for each supported language (based upon the language settings of the current web). The generated resource files will be named 'MyResources.en-US.resx' etc.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 11---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $template = Get-PnPProvisioningTemplate -OutputInstance</dev:code> <maml:remarks> <maml:para>Extracts an instance of a provisioning template object from the current web. This syntax cannot be used together with the -Out parameter, but it can be used together with any other supported parameters.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 12---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPProvisioningTemplate -Out template.pnp -ContentTypeGroups "Group A","Group B"</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web, but only processes content types from the to given content type groups.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 13---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPProvisioningTemplate -Out template.pnp -ExcludeContentTypesFromSyndication</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web, excluding content types provisioned through content type syndication (content type hub), in order to prevent provisioning errors if the target also provision the content type using syndication.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 14---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPProvisioningTemplate -Out template.pnp -ListsToExtract "Title of List One","95c4efd6-08f4-4c67-94ae-49d696ba1298","Title of List Three"</dev:code> <maml:remarks> <maml:para>Extracts a provisioning template in Office Open XML from the current web, including only the lists specified by title or ID.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Encoding:</maml:linkText> <maml:uri>https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPPublishingImageRendition</command:name> <maml:description> <maml:para>Returns all image renditions or if Identity is specified a specific one</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPPublishingImageRendition</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPublishingImageRendition</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id or name of an existing image rendition</maml:para> </maml:description> <command:parameterValue required="true">ImageRenditionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id or name of an existing image rendition</maml:para> </maml:description> <command:parameterValue required="false">ImageRenditionPipeBind</command:parameterValue> <dev:type> <maml:name>ImageRenditionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Publishing.ImageRendition</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPPublishingImageRendition</dev:code> <maml:remarks> <maml:para>Returns all Image Renditions</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPPublishingImageRendition -Identity "Test"</dev:code> <maml:remarks> <maml:para>Returns the image rendition named "Test"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPPublishingImageRendition -Identity 2</dev:code> <maml:remarks> <maml:para>Returns the image rendition where its id equals 2</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPRecycleBinItem</command:name> <maml:description> <maml:para>Returns the items in the recycle bin from the context</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPRecycleBinItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPRecycleBinItem</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Returns a recycle bin item with a specific identity</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPRecycleBinItem</maml:name> <command:parameter required="false" position="named"> <maml:name>FirstStage</maml:name> <maml:description> <maml:para>Return all items in the first stage recycle bin</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>Limits return results to specified amount</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPRecycleBinItem</maml:name> <command:parameter required="false" position="named"> <maml:name>SecondStage</maml:name> <maml:description> <maml:para>Return all items in the second stage recycle bin</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>Limits return results to specified amount</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPRecycleBinItem</maml:name> <command:parameter required="false" position="named"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>Limits return results to specified amount</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPRecycleBinItem</maml:name> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>FirstStage</maml:name> <maml:description> <maml:para>Return all items in the first stage recycle bin</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Returns a recycle bin item with a specific identity</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>Limits return results to specified amount</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SecondStage</maml:name> <maml:description> <maml:para>Return all items in the second stage recycle bin</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.RecycleBinItem</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPRecycleBinItem</dev:code> <maml:remarks> <maml:para>Returns all items in both the first and the second stage recycle bins in the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPRecycleBinItem -Identity f3ef6195-9400-4121-9d1c-c997fb5b86c2</dev:code> <maml:remarks> <maml:para>Returns all a specific recycle bin item by id</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPRecycleBinItem -FirstStage</dev:code> <maml:remarks> <maml:para>Returns all items in only the first stage recycle bin in the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPRecycleBinItem -SecondStage</dev:code> <maml:remarks> <maml:para>Returns all items in only the second stage recycle bin in the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPRecycleBinItem -RowLimit 10000</dev:code> <maml:remarks> <maml:para>Returns items in recycle bin limited by number of results</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPRequestAccessEmails</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns the request access e-mail addresses</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPRequestAccessEmails</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPRequestAccessEmails</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<System.String></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPRequestAccessEmails</dev:code> <maml:remarks> <maml:para>This will return all the request access e-mail addresses for the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPRoleDefinition</command:name> <maml:description> <maml:para>Retrieves a Role Definitions of a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPRoleDefinition</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPRoleDefinition</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of a role definition to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">RoleDefinitionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of a role definition to retrieve.</maml:para> </maml:description> <command:parameterValue required="false">RoleDefinitionPipeBind</command:parameterValue> <dev:type> <maml:name>RoleDefinitionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.RoleDefinition</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPRoleDefinition</dev:code> <maml:remarks> <maml:para>Retrieves the Role Definitions (Permission Levels) settings of the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPRoleDefinition -Identity Read</dev:code> <maml:remarks> <maml:para>Retrieves the specified Role Definition (Permission Level) settings of the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSearchConfiguration</command:name> <maml:description> <maml:para>Returns the search configuration</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSearchConfiguration</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSearchConfiguration</maml:name> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Local path where the search configuration will be saved</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope to use. Either Web, Site, or Subscription. Defaults to Web</maml:para> </maml:description> <command:parameterValue required="true">SearchConfigurationScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPSearchConfiguration</maml:name> <command:parameter required="false" position="named"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Output format for of the configuration. Defaults to complete XML</maml:para> </maml:description> <command:parameterValue required="true">OutputFormat</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope to use. Either Web, Site, or Subscription. Defaults to Web</maml:para> </maml:description> <command:parameterValue required="true">SearchConfigurationScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>Output format for of the configuration. Defaults to complete XML</maml:para> </maml:description> <command:parameterValue required="false">OutputFormat</command:parameterValue> <dev:type> <maml:name>OutputFormat</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Local path where the search configuration will be saved</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope to use. Either Web, Site, or Subscription. Defaults to Web</maml:para> </maml:description> <command:parameterValue required="false">SearchConfigurationScope</command:parameterValue> <dev:type> <maml:name>SearchConfigurationScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>Does not return a string when the -Path parameter has been specified.</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSearchConfiguration</dev:code> <maml:remarks> <maml:para>Returns the search configuration for the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSearchConfiguration -Scope Site</dev:code> <maml:remarks> <maml:para>Returns the search configuration for the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSearchConfiguration -Scope Subscription</dev:code> <maml:remarks> <maml:para>Returns the search configuration for the current tenant</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSearchConfiguration -Path searchconfig.xml -Scope Subscription</dev:code> <maml:remarks> <maml:para>Returns the search configuration for the current tenant and saves it to the specified file</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSearchConfiguration -Scope Site -OutputFormat ManagedPropertyMappings</dev:code> <maml:remarks> <maml:para>Returns all custom managed properties and crawled property mapping at the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSearchCrawlLog</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns entries from the SharePoint search crawl log. Make sure you are granted access to the crawl log via the SharePoint search admin center at https://<tenant>-admin.sharepoint.com/_layouts/15/searchadmin/crawllogreadpermission.aspx in order to run this cmdlet.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSearchCrawlLog</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSearchCrawlLog</maml:name> <command:parameter required="false" position="named"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>Filter what log entries to return (All, Success, Warning, Error). Defaults to All</maml:para> </maml:description> <command:parameterValue required="true">LogLevel</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>Number of entries to return. Defaults to 100.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter to limit what is being returned. Has to be a URL prefix for SharePoint content, and part of a user principal name for user profiles. Wildcard characters are not supported.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentSource</maml:name> <maml:description> <maml:para>Content to retrieve (Sites, User Profiles). Defaults to Sites.</maml:para> </maml:description> <command:parameterValue required="true">ContentSource</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start date to start getting entries from. Defaults to start of time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>End date to stop getting entries from. Default to current time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RawFormat</maml:name> <maml:description> <maml:para>Show raw crawl log data</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ContentSource</maml:name> <maml:description> <maml:para>Content to retrieve (Sites, User Profiles). Defaults to Sites.</maml:para> </maml:description> <command:parameterValue required="false">ContentSource</command:parameterValue> <dev:type> <maml:name>ContentSource</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>End date to stop getting entries from. Default to current time.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter to limit what is being returned. Has to be a URL prefix for SharePoint content, and part of a user principal name for user profiles. Wildcard characters are not supported.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>Filter what log entries to return (All, Success, Warning, Error). Defaults to All</maml:para> </maml:description> <command:parameterValue required="false">LogLevel</command:parameterValue> <dev:type> <maml:name>LogLevel</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RawFormat</maml:name> <maml:description> <maml:para>Show raw crawl log data</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>Number of entries to return. Defaults to 100.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start date to start getting entries from. Defaults to start of time.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSearchCrawlLog</dev:code> <maml:remarks> <maml:para>Returns the last 100 crawl log entries for site content.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSearchCrawlLog -Filter "https://<tenant>-my.sharepoint.com/personal"</dev:code> <maml:remarks> <maml:para>Returns the last 100 crawl log entries for OneDrive content.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSearchCrawlLog -ContentSource UserProfiles </dev:code> <maml:remarks> <maml:para>Returns the last 100 crawl log entries for user profiles.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSearchCrawlLog -ContentSource UserProfiles -Filter "mikael"</dev:code> <maml:remarks> <maml:para>Returns the last 100 crawl log entries for user profiles with the term "mikael" in the user principal name.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSearchCrawlLog -ContentSource Sites -LogLevel Error -RowLimit 10</dev:code> <maml:remarks> <maml:para>Returns the last 10 crawl log entries with a state of Error for site content.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSearchCrawlLog -EndDate (Get-Date).AddDays(-100)</dev:code> <maml:remarks> <maml:para>Returns the last 100 crawl log entries up until 100 days ago.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSearchCrawlLog -RowFilter 3 -RawFormat</dev:code> <maml:remarks> <maml:para>Returns the last 3 crawl log entries showing the raw crawl log data.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSearchSettings</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Retrieves search settings for a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSearchSettings</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSearchSettings</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSearchSettings</dev:code> <maml:remarks> <maml:para>Retrieve search settings for the site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSite</command:name> <maml:description> <maml:para>Returns the current site collection from the context.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSite</maml:name> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Site</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSite</dev:code> <maml:remarks> <maml:para>Gets the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSite -Includes RootWeb,ServerRelativeUrl</dev:code> <maml:remarks> <maml:para>Gets the current site specifying to include RootWeb and ServerRelativeUrl properties. For the full list of properties see https://docs.microsoft.com/previous-versions/office/sharepoint-server/ee538579(v%3doffice.15)</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSiteClassification</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns the defined Site Classifications for the tenant. Requires a connection to the Microsoft Graph.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSiteClassification</command:noun> <dev:version /> </command:details> <command:syntax /> <command:parameters /> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" PS:> Get-PnPSiteClassification</dev:code> <maml:remarks> <maml:para>Returns the currently set site classifications for the tenant.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSiteClosure</command:name> <maml:description> <maml:para>Get the site closure status of the site which has a site policy applied</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSiteClosure</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteClosure</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteClosure</dev:code> <maml:remarks> <maml:para>Get the site closure status of the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSiteCollectionAdmin</command:name> <maml:description> <maml:para>Returns the current site collection administrators of the site collection in the current context</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSiteCollectionAdmin</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command will return all current site collection administrators of the site collection in the current context</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteCollectionAdmin</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteCollectionAdmin</dev:code> <maml:remarks> <maml:para>This will return all the current site collection administrators of the site collection in the current context</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSiteDesign</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Retrieve Site Designs that have been registered on the current tenant.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSiteDesign</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteDesign</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified will retrieve the specified site design</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified will retrieve the specified site design</maml:para> </maml:description> <command:parameterValue required="false">TenantSiteDesignPipeBind</command:parameterValue> <dev:type> <maml:name>TenantSiteDesignPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteDesign</dev:code> <maml:remarks> <maml:para>Returns all registered site designs</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd</dev:code> <maml:remarks> <maml:para>Returns a specific registered site designs</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSiteDesignRights</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns the principals with design rights on a specific Site Design</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSiteDesignRights</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteDesignRights</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the Site Design to receive the rights for</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the Site Design to receive the rights for</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> <dev:type> <maml:name>TenantSiteDesignPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteDesignRights -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd</dev:code> <maml:remarks> <maml:para>Returns the principals with rights on a specific site design</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSiteDesignRun</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Retrieves a list of site designs applied to a specified site collection. If the WebUrl parameter is not specified we show the list of designs applied to the current site. The returned output includes the ID of the scheduled job, the web and site IDs, and the site design ID, version, and title.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSiteDesignRun</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteDesignRun</maml:name> <command:parameter required="false" position="named"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para>The ID of the site design to apply.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the site collection where the site design will be applied. If not specified the design will be applied to the site you connected to with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para>The ID of the site design to apply.</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the site collection where the site design will be applied. If not specified the design will be applied to the site you connected to with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteDesignRun</dev:code> <maml:remarks> <maml:para>This example returns a list of the site designs applied to the current site. Providing a specific site design ID will return the details for just that applied site design.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteDesignRun -WebUrl https://mytenant.sharepoint.com/sites/project</dev:code> <maml:remarks> <maml:para>This example returns a list of the site designs applied to the specified site. Providing a specific site design ID will return the details for just that applied site design.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSiteDesignRunStatus</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Retrieves and displays a list of all site script actions executed for a specified site design applied to a site.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSiteDesignRunStatus</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteDesignRunStatus</maml:name> <command:parameter required="true" position="named"> <maml:name>Run</maml:name> <maml:description> <maml:para>The site design run for the desired set of script action details.</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignRun</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Run</maml:name> <maml:description> <maml:para>The site design run for the desired set of script action details.</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignRun</command:parameterValue> <dev:type> <maml:name>TenantSiteDesignRun</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $myrun = Get-PnPSiteDesignRun -WebUrl "https://contoso.sharepoint.com/sites/project-playbook" -SiteDesignId cefd782e-sean-4814-a68a-b33b116c302f PS:> Get-PnPSiteDesignRunStatus -Run $myrun</dev:code> <maml:remarks> <maml:para>This example gets the run for a specific site design applied to a site and sets it to a variable. This variable is then passed into the command -Run parameter. The result is a display of all the site script actions applied for that site design run, including the script action title and outcome. </maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSiteDesignTask</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Used to retrieve a scheduled site design script. It takes the ID of the scheduled site design and the URL for the site where the site design is scheduled to be applied. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSiteDesignTask</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteDesignTask</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the site design to apply.</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignTaskPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the site collection where the site design will be applied. If not specified the design will be applied to the site you connected to with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the site design to apply.</maml:para> </maml:description> <command:parameterValue required="false">TenantSiteDesignTaskPipeBind</command:parameterValue> <dev:type> <maml:name>TenantSiteDesignTaskPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the site collection where the site design will be applied. If not specified the design will be applied to the site you connected to with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteDesignTask -Identity 501z8c32-4147-44d4-8607-26c2f67cae82</dev:code> <maml:remarks> <maml:para>This example retrieves a site design task given the provided site design task id</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteDesignTask</dev:code> <maml:remarks> <maml:para>This example retrieves all site design tasks currently scheduled on the current site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteDesignTask -WebUrl "https://contoso.sharepoint.com/sites/project"</dev:code> <maml:remarks> <maml:para>This example retrieves all site design tasks currently scheduled on the provided site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSitePolicy</command:name> <maml:description> <maml:para>Retrieves all or a specific site policy</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSitePolicy</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSitePolicy</maml:name> <command:parameter required="false" position="named"> <maml:name>AllAvailable</maml:name> <maml:description> <maml:para>Retrieve all available site policies</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Retrieves a site policy with a specific name</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AllAvailable</maml:name> <maml:description> <maml:para>Retrieve all available site policies</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Retrieves a site policy with a specific name</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OfficeDevPnP.Core.Entities.SitePolicyEntity</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSitePolicy</dev:code> <maml:remarks> <maml:para>Retrieves the current applied site policy.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSitePolicy -AllAvailable</dev:code> <maml:remarks> <maml:para>Retrieves all available site policies.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSitePolicy -Name "Contoso HBI"</dev:code> <maml:remarks> <maml:para>Retrieves an available site policy with the name "Contoso HBI".</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSiteScript</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Retrieve Site Scripts that have been registered on the current tenant.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSiteScript</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteScript</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified will retrieve the specified site script</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteScriptPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SiteDesign</maml:name> <maml:description> <maml:para>If specified will retrieve the site scripts for this design</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified will retrieve the specified site script</maml:para> </maml:description> <command:parameterValue required="false">TenantSiteScriptPipeBind</command:parameterValue> <dev:type> <maml:name>TenantSiteScriptPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SiteDesign</maml:name> <maml:description> <maml:para>If specified will retrieve the site scripts for this design</maml:para> </maml:description> <command:parameterValue required="false">TenantSiteDesignPipeBind</command:parameterValue> <dev:type> <maml:name>TenantSiteDesignPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteScript</dev:code> <maml:remarks> <maml:para>Returns all registered site scripts</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteScript -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd</dev:code> <maml:remarks> <maml:para>Returns a specific registered site script</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSiteScriptFromList</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Generates a Site Script from an existing list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSiteScriptFromList</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command allows a Site Script to be generated off of an existing list on your tenant. Connect to your SharePoint Online Admin site before executing this command.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteScriptFromList</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the list to generate a Site Script from</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the list to generate a Site Script from</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteScriptFromList -Url https://contoso.sharepoint.com/sites/teamsite/lists/MyList</dev:code> <maml:remarks> <maml:para>Returns the generated Site Script JSON from the list "MyList" at the provided Url</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteScriptFromList -Url "https://contoso.sharepoint.com/sites/teamsite/Shared Documents"</dev:code> <maml:remarks> <maml:para>Returns the generated Site Script JSON from the default document library at the provided Url</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSiteScriptFromWeb</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Generates a Site Script from an existing site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSiteScriptFromWeb</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command allows a Site Script to be generated off of an existing site on your tenant. Connect to your SharePoint Online Admin site before executing this command.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteScriptFromWeb</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site to generate a Site Script from</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeAll</maml:name> <maml:description> <maml:para>If specified will include all supported components into the Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lists</maml:name> <maml:description> <maml:para>Allows specifying one or more site relative URLs of lists that should be included into the Site Script, i.e. "Shared Documents","List\MyList"</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPSiteScriptFromWeb</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site to generate a Site Script from</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeBranding</maml:name> <maml:description> <maml:para>If specified will include the branding of the site into the Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeLinksToExportedItems</maml:name> <maml:description> <maml:para>If specified will include navigation links into the Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeRegionalSettings</maml:name> <maml:description> <maml:para>If specified will include the regional settings into the Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSiteExternalSharingCapability</maml:name> <maml:description> <maml:para>If specified will include the external sharing configuration into the Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeTheme</maml:name> <maml:description> <maml:para>If specified will include the branding of the site into the Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lists</maml:name> <maml:description> <maml:para>Allows specifying one or more site relative URLs of lists that should be included into the Site Script, i.e. "Shared Documents","List\MyList"</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>IncludeAll</maml:name> <maml:description> <maml:para>If specified will include all supported components into the Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeBranding</maml:name> <maml:description> <maml:para>If specified will include the branding of the site into the Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeLinksToExportedItems</maml:name> <maml:description> <maml:para>If specified will include navigation links into the Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeRegionalSettings</maml:name> <maml:description> <maml:para>If specified will include the regional settings into the Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeSiteExternalSharingCapability</maml:name> <maml:description> <maml:para>If specified will include the external sharing configuration into the Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeTheme</maml:name> <maml:description> <maml:para>If specified will include the branding of the site into the Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lists</maml:name> <maml:description> <maml:para>Allows specifying one or more site relative URLs of lists that should be included into the Site Script, i.e. "Shared Documents","List\MyList"</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site to generate a Site Script from</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteScriptFromWeb -Url https://contoso.sharepoint.com/sites/teamsite -IncludeAll</dev:code> <maml:remarks> <maml:para>Returns the generated Site Script JSON containing all supported components from the site at the provided Url</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteScriptFromWeb -Url https://contoso.sharepoint.com/sites/teamsite -IncludeAll -Lists "Shared Documents","Lists\MyList"</dev:code> <maml:remarks> <maml:para>Returns the generated Site Script JSON containing all supported components from the site at the provided Url including the lists "Shared Documents" and "MyList"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteScriptFromWeb -Url https://contoso.sharepoint.com/sites/teamsite -IncludeBranding -IncludeLinksToExportedItems</dev:code> <maml:remarks> <maml:para>Returns the generated Site Script JSON containing the branding and navigation links from the site at the provided Url</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSiteSearchQueryResults</command:name> <maml:description> <maml:para>Executes a search query to retrieve indexed site collections</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSiteSearchQueryResults</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteSearchQueryResults</maml:name> <command:parameter required="false" position="named"> <maml:name>StartRow</maml:name> <maml:description> <maml:para>Search result item to start returning the results from. Useful for paging. Leave at 0 to return all results.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Maximum amount of search results to return. Default and max is 500 search results.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>Search query in Keyword Query Language (KQL) to execute to refine the returned sites. If omitted, all indexed sites will be returned.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPSiteSearchQueryResults</maml:name> <command:parameter required="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Automatically page results until the end to get more than 500 sites. Use with caution!</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>Search query in Keyword Query Language (KQL) to execute to refine the returned sites. If omitted, all indexed sites will be returned.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Automatically page results until the end to get more than 500 sites. Use with caution!</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Maximum amount of search results to return. Default and max is 500 search results.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>Search query in Keyword Query Language (KQL) to execute to refine the returned sites. If omitted, all indexed sites will be returned.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartRow</maml:name> <maml:description> <maml:para>Search result item to start returning the results from. Useful for paging. Leave at 0 to return all results.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<System.Object></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteSearchQueryResults</dev:code> <maml:remarks> <maml:para>Returns the top 500 site collections indexed by SharePoint Search</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteSearchQueryResults -Query "WebTemplate:STS"</dev:code> <maml:remarks> <maml:para>Returns the top 500 site collections indexed by SharePoint Search which have are based on the STS (Team Site) template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteSearchQueryResults -Query "WebTemplate:SPSPERS"</dev:code> <maml:remarks> <maml:para>Returns the top 500 site collections indexed by SharePoint Search which have are based on the SPSPERS (MySite) template, up to the MaxResult limit</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteSearchQueryResults -Query "Title:Intranet*"</dev:code> <maml:remarks> <maml:para>Returns the top 500 site collections indexed by SharePoint Search of which the title starts with the word Intranet</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteSearchQueryResults -MaxResults 10</dev:code> <maml:remarks> <maml:para>Returns the top 10 site collections indexed by SharePoint Search</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteSearchQueryResults -All</dev:code> <maml:remarks> <maml:para>Returns absolutely all site collections indexed by SharePoint Search</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPContext</command:name> <maml:description> <maml:para>Returns the current context</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPContext</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns a Client Side Object Model context</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.ClientContext</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $ctx = Get-PnPContext</dev:code> <maml:remarks> <maml:para>This will put the current context in the $ctx variable.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url $siteAurl -Credentials $credentials PS:> $ctx = Get-PnPContext PS:> Get-PnPList # returns the lists from site specified with $siteAurl PS:> Connect-PnPOnline -Url $siteBurl -Credentials $credentials PS:> Get-PnPList # returns the lists from the site specified with $siteBurl PS:> Set-PnPContext -Context $ctx # switch back to site A PS:> Get-PnPList # returns the lists from site A</dev:code> <maml:remarks> <maml:para /> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPStoredCredential</command:name> <maml:description> <maml:para>Get a credential</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPStoredCredential</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns a stored credential from the Windows Credential Manager</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPStoredCredential</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The credential to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The object type of the credential to return from the Credential Manager. Possible values are 'O365', 'OnPrem' or 'PSCredential'</maml:para> </maml:description> <command:parameterValue required="true">CredentialType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The credential to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The object type of the credential to return from the Credential Manager. Possible values are 'O365', 'OnPrem' or 'PSCredential'</maml:para> </maml:description> <command:parameterValue required="false">CredentialType</command:parameterValue> <dev:type> <maml:name>CredentialType</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPStoredCredential -Name O365</dev:code> <maml:remarks> <maml:para>Returns the credential associated with the specified identifier</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPStoredCredential -Name testEnvironment -Type OnPrem</dev:code> <maml:remarks> <maml:para>Gets the credential associated with the specified identifier from the credential manager and then will return a credential that can be used for on-premises authentication</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPSubWebs</command:name> <maml:description> <maml:para>Returns the subwebs of the current web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPSubWebs</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSubWebs</maml:name> <command:parameter required="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>If provided, recursion through all subsites and their children will take place to return them as well</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If provided, only the subsite with the provided Id, GUID or the Web instance will be returned</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If provided, only the subsite with the provided Id, GUID or the Web instance will be returned</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>If provided, recursion through all subsites and their children will take place to return them as well</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Web</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSubWebs</dev:code> <maml:remarks> <maml:para>Retrieves all subsites of the current context returning the Id, Url, Title and ServerRelativeUrl of each subsite in the output</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSubWebs -Recurse</dev:code> <maml:remarks> <maml:para>Retrieves all subsites of the current context and all of their nested child subsites returning the Id, Url, Title and ServerRelativeUrl of each subsite in the output</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSubWebs -Recurse -Includes "WebTemplate","Description" | Select ServerRelativeUrl, WebTemplate, Description</dev:code> <maml:remarks> <maml:para>Retrieves all subsites of the current context and shows the ServerRelativeUrl, WebTemplate and Description properties in the resulting output</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSubWebs -Identity Team1 -Recurse</dev:code> <maml:remarks> <maml:para>Retrieves all subsites of the subsite Team1 and all of its nested child subsites returning the Id, Url, Title and ServerRelativeUrl of each subsite in the output</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTaxonomyItem</command:name> <maml:description> <maml:para>Returns a taxonomy item</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTaxonomyItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTaxonomyItem</maml:name> <command:parameter required="true" position="named"> <maml:name>TermPath</maml:name> <maml:description> <maml:para>The path, delimited by | of the taxonomy item to retrieve, alike GROUPLABEL|TERMSETLABEL|TERMLABEL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>TermPath</maml:name> <maml:description> <maml:para>The path, delimited by | of the taxonomy item to retrieve, alike GROUPLABEL|TERMSETLABEL|TERMLABEL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Taxonomy.TaxonomyItem</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTaxonomySession</command:name> <maml:description> <maml:para>Returns a taxonomy session</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTaxonomySession</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTaxonomySession</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Taxonomy.TaxonomySession</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenant</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns organization-level site collection properties</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenant</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns organization-level site collection properties such as StorageQuota, StorageQuotaAllocated, ResourceQuota, ResourceQuotaAllocated, and SiteCreationMode. Currently, there are no parameters for this cmdlet. You must be a SharePoint Online global administrator to run the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenant</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenant</dev:code> <maml:remarks> <maml:para>This example returns all tenant settings</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantAppCatalogUrl</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Retrieves the url of the tenant scoped app catalog</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantAppCatalogUrl</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantAppCatalogUrl</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantAppCatalogUrl</dev:code> <maml:remarks> <maml:para>Returns the url of the tenant scoped app catalog site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantCdnEnabled</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Retrieves if the Office 365 Content Delivery Network has been enabled.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantCdnEnabled</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Enables or disabled the public or private Office 365 Content Delivery Network (CDN).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantCdnEnabled</maml:name> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>The type of cdn to retrieve the origins from</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>The type of cdn to retrieve the origins from</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> <dev:type> <maml:name>SPOTenantCdnType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantCdnEnabled -CdnType Public</dev:code> <maml:remarks> <maml:para>Returns the enabled status of the specified CDN</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantCdnOrigin</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns the current registered origins from the public or private content delivery network (CDN).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantCdnOrigin</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns the current registered origins from the public or private content delivery network (CDN).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantCdnOrigin</maml:name> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>The type of cdn to retrieve the origins from</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>The type of cdn to retrieve the origins from</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> <dev:type> <maml:name>SPOTenantCdnType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantCdnOrigin -CdnType Public</dev:code> <maml:remarks> <maml:para>Returns the configured CDN origins for the specified CDN type</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantCdnPolicies</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns the CDN Policies for the specified CDN (Public | Private).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantCdnPolicies</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Enables or disabled the public or private Office 365 Content Delivery Network (CDN).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantCdnPolicies</maml:name> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>The type of cdn to retrieve the policies from</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>The type of cdn to retrieve the policies from</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> <dev:type> <maml:name>SPOTenantCdnType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantCdnPolicies -CdnType Public</dev:code> <maml:remarks> <maml:para>Returns the policies for the specified CDN type</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantId</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns the Tenant ID</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantId</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantId</maml:name> <command:parameter required="false" position="named"> <maml:name>TenantUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>TenantUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantId</dev:code> <maml:remarks> <maml:para>Returns the current Tenant Id. A valid connection with Connect-PnPOnline is required.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantId -TenantUrl https://contoso.sharepoint.com</dev:code> <maml:remarks> <maml:para>Returns the Tenant ID for the specified tenant. Can be executed without a connecting first with Connect-PnPOnline</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantRecycleBinItem</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns all modern and classic site collections in the tenant scoped recycle bin</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantRecycleBinItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command will return all the items in the tenant recycle bin for the Office 365 tenant you are connected to. Be sure to connect to the SharePoint Online Admin endpoint (https://yourtenantname-admin.sharepoint.com) in order for this command to work.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantRecycleBinItem</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Online.SharePoint.TenantAdministration.DeletedSiteProperties</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantRecycleBinItem</dev:code> <maml:remarks> <maml:para>Returns all modern and classic site collections in the tenant scoped recycle bin</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantSequence</command:name> <maml:description> <maml:para>Returns one ore more provisioning sequence object(s) from a tenant template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantSequence</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantSequence</maml:name> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The template to retrieve the sequence from</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningHierarchy</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Optional Id of the sequence</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningSequencePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Optional Id of the sequence</maml:para> </maml:description> <command:parameterValue required="false">ProvisioningSequencePipeBind</command:parameterValue> <dev:type> <maml:name>ProvisioningSequencePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The template to retrieve the sequence from</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningHierarchy</command:parameterValue> <dev:type> <maml:name>ProvisioningHierarchy</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantSequence -Template $myTemplateObject</dev:code> <maml:remarks> <maml:para>Returns all sequences from the specified tenant template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantSequence -Template $myTemplateObject -Identity "mysequence"</dev:code> <maml:remarks> <maml:para>Returns the specified sequence from the specified tenant template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantSequenceSite</command:name> <maml:description> <maml:para>Returns one ore more sites from a tenant template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantSequenceSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantSequenceSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>The sequence to retrieve the site from</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningSequence</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Optional Id of the site</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningSitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Optional Id of the site</maml:para> </maml:description> <command:parameterValue required="false">ProvisioningSitePipeBind</command:parameterValue> <dev:type> <maml:name>ProvisioningSitePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>The sequence to retrieve the site from</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningSequence</command:parameterValue> <dev:type> <maml:name>ProvisioningSequence</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantSequenceSite -Sequence $mysequence</dev:code> <maml:remarks> <maml:para>Returns all sites from the specified sequence</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantSequenceSite -Sequence $mysequence -Identity 8058ea99-af7b-4bb7-b12a-78f93398041e</dev:code> <maml:remarks> <maml:para>Returns the specified site from the specified sequence</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantServicePrincipal</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns the current tenant's "SharePoint Online Client" service principal.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantServicePrincipal</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns the current tenant's "SharePoint Online Client" service principal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantServicePrincipal</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantServicePrincipalPermissionGrants</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Gets the collection of permission grants for the "SharePoint Online Client" service principal</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantServicePrincipalPermissionGrants</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets the collection of permission grants for the "SharePoint Online Client" service principal. A permission grant contains the following properties: * ClientId: The objectId of the service principal granted consent to impersonate the user when accessing the resource(represented by the resourceId). * ConsentType: Whether consent was provided by the administrator on behalf of the organization or whether consent was provided by an individual.The possible values are "AllPrincipals" or "Principal". * ObjectId: The unique identifier for the permission grant. * Resource: The resource to which access has been granted (Coming soon) * ResourceId: The objectId of the resource service principal to which access has been granted. * Scope: The value of the scope claim that the resource application should expect in the OAuth 2.0 access token. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantServicePrincipalPermissionGrants</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantServicePrincipalPermissionRequests</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Gets the collection of permission requests for the "SharePoint Online Client" service principal</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantServicePrincipalPermissionRequests</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets the collection of permission requests for the "SharePoint Online Client" service principal. Permission request object A permission request contains the following properties: * Id: The identifier of the request. * Resource: The resource that the application requires access to. * Scope: The value of the scope claim that the resource application should expect in the OAuth 2.0 access token. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantServicePrincipalPermissionRequests</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Retrieve site information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantSite</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Use this cmdlet to retrieve site information from your tenant administration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantSite</maml:name> <command:parameter required="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>By default, all sites will be returned. Specify a template value alike "STS#0" here to filter on the template</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>By default, not all returned attributes are populated. This switch populates all attributes. It can take several seconds to run. Without this, some attributes will show default values that may not be correct.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeOneDriveSites</maml:name> <maml:description> <maml:para>By default, the OneDrives are not returned. This switch includes all OneDrives.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the script block of the server-side filter to apply. See https://technet.microsoft.com/en-us/library/fp161380.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The URL of the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>By default, not all returned attributes are populated. This switch populates all attributes. It can take several seconds to run. Without this, some attributes will show default values that may not be correct.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the script block of the server-side filter to apply. See https://technet.microsoft.com/en-us/library/fp161380.aspx</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeOneDriveSites</maml:name> <maml:description> <maml:para>By default, the OneDrives are not returned. This switch includes all OneDrives.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>By default, all sites will be returned. Specify a template value alike "STS#0" here to filter on the template</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The URL of the site</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Online.SharePoint.TenantAdministration.SiteProperties</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantSite</dev:code> <maml:remarks> <maml:para>Returns all site collections</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantSite -Url http://tenant.sharepoint.com/sites/projects</dev:code> <maml:remarks> <maml:para>Returns information about the project site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantSite -Detailed</dev:code> <maml:remarks> <maml:para>Returns all sites with the full details of these sites</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantSite -IncludeOneDriveSites</dev:code> <maml:remarks> <maml:para>Returns all sites including all OneDrive for Business sites</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantSite -IncludeOneDriveSites -Filter "Url -like '-my.sharepoint.com/personal/'"</dev:code> <maml:remarks> <maml:para>Returns all OneDrive for Business sites</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantSite -Template SITEPAGEPUBLISHING#0</dev:code> <maml:remarks> <maml:para>Returns all Communication sites</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantSite -Filter "Url -like 'sales'" </dev:code> <maml:remarks> <maml:para>Returns all sites including 'sales' in the url</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantTemplate</command:name> <maml:description> <maml:para>Generates a provisioning tenant template from a site. If the site is a hubsite any connected site will be included.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="true">ExtractConfigurationPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPTenantTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>AsInstance</maml:name> <maml:description> <maml:para>Returns the template as an in-memory object, which is an instance of the ProvisioningHierarchy type of the PnP Core Component. It cannot be used together with the -Out parameter.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="true">ExtractConfigurationPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>AsInstance</maml:name> <maml:description> <maml:para>Returns the template as an in-memory object, which is an instance of the ProvisioningHierarchy type of the PnP Core Component. It cannot be used together with the -Out parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="false">ExtractConfigurationPipeBind</command:parameterValue> <dev:type> <maml:name>ExtractConfigurationPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantTemplate -Out tenanttemplate.xml</dev:code> <maml:remarks> <maml:para>Extracts a tenant template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTenantTheme</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns all or a specific theme</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTenantTheme</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns all or a specific tenant theme.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTenantTheme</maml:name> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the theme to retrieve</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the theme to retrieve</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantTheme</dev:code> <maml:remarks> <maml:para>Returns all themes</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantTheme -Name "MyCompanyTheme"</dev:code> <maml:remarks> <maml:para>Returns the specified theme</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTerm</command:name> <maml:description> <maml:para>Returns a taxonomy term</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTerm</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTerm</maml:name> <command:parameter required="false" position="named"> <maml:name>IncludeChildTerms</maml:name> <maml:description> <maml:para>Includes the hierarchy of child terms if available</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPTerm</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id or Name of a Term</maml:para> </maml:description> <command:parameterValue required="true">Id, Name or Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStore</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">Id, Name or Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeChildTerms</maml:name> <maml:description> <maml:para>Includes the hierarchy of child terms if available</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPTerm</maml:name> <command:parameter required="true" position="named"> <maml:name>TermSet</maml:name> <maml:description> <maml:para>Name of the termset to check.</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TaxonomyItem</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermGroup</maml:name> <maml:description> <maml:para>Name of the termgroup to check.</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TermGroup</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id or Name of a Term</maml:para> </maml:description> <command:parameterValue required="true">Id, Name or Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStore</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">Id, Name or Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>Find the first term recursively matching the label in a term hierarchy.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeChildTerms</maml:name> <maml:description> <maml:para>Includes the hierarchy of child terms if available</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id or Name of a Term</maml:para> </maml:description> <command:parameterValue required="true">Id, Name or Object</command:parameterValue> <dev:type> <maml:name>Id, Name or Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeChildTerms</maml:name> <maml:description> <maml:para>Includes the hierarchy of child terms if available</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>Find the first term recursively matching the label in a term hierarchy.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermGroup</maml:name> <maml:description> <maml:para>Name of the termgroup to check.</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TermGroup</command:parameterValue> <dev:type> <maml:name>Id, Title or TermGroup</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermSet</maml:name> <maml:description> <maml:para>Name of the termset to check.</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TaxonomyItem</command:parameterValue> <dev:type> <maml:name>Id, Title or TaxonomyItem</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStore</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="false">Id, Name or Object</command:parameterValue> <dev:type> <maml:name>Id, Name or Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Taxonomy.Term</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTerm -TermSet "Departments" -TermGroup "Corporate"</dev:code> <maml:remarks> <maml:para>Returns all term in the termset "Departments" which is in the group "Corporate" from the site collection termstore</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTerm -Identity "Finance" -TermSet "Departments" -TermGroup "Corporate"</dev:code> <maml:remarks> <maml:para>Returns the term named "Finance" in the termset "Departments" from the termgroup called "Corporate" from the site collection termstore</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTerm -Identity ab2af486-e097-4b4a-9444-527b251f1f8d -TermSet "Departments" -TermGroup "Corporate"</dev:code> <maml:remarks> <maml:para>Returns the term named with the given id, from the "Departments" termset in a term group called "Corporate" from the site collection termstore</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTerm -Identity "Small Finance" -TermSet "Departments" -TermGroup "Corporate" -Recursive</dev:code> <maml:remarks> <maml:para>Returns the term named "Small Finance", from the "Departments" termset in a term group called "Corporate" from the site collection termstore even if it's a subterm below "Finance"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $term = Get-PnPTerm -Identity "Small Finance" -TermSet "Departments" -TermGroup "Corporate" -Include Labels PS:> $term.Labels</dev:code> <maml:remarks> <maml:para>Returns all the localized labels for the term named "Small Finance", from the "Departments" termset in a term group called "Corporate"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTermGroup</command:name> <maml:description> <maml:para>Returns a taxonomy term group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTermGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTermGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>TermStore</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">Id, Name or Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Name of the taxonomy term group to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TaxonomyItem</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Name of the taxonomy term group to retrieve.</maml:para> </maml:description> <command:parameterValue required="false">Id, Title or TaxonomyItem</command:parameterValue> <dev:type> <maml:name>Id, Title or TaxonomyItem</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStore</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="false">Id, Name or Object</command:parameterValue> <dev:type> <maml:name>Id, Name or Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Taxonomy.TermGroup</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTermGroup</dev:code> <maml:remarks> <maml:para>Returns all Term Groups in the site collection termstore</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTermGroup -Identity "Departments"</dev:code> <maml:remarks> <maml:para>Returns the termgroup named "Departments" from the site collection termstore</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTermGroup -Identity ab2af486-e097-4b4a-9444-527b251f1f8d</dev:code> <maml:remarks> <maml:para>Returns the termgroup with the given ID from the site collection termstore</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTermSet</command:name> <maml:description> <maml:para>Returns a taxonomy term set</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTermSet</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTermSet</maml:name> <command:parameter required="true" position="named"> <maml:name>TermGroup</maml:name> <maml:description> <maml:para>Name of the term group to check.</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TermGroup</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id or Name of a termset</maml:para> </maml:description> <command:parameterValue required="true">Id, Name or Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStore</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">Id, Name or Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id or Name of a termset</maml:para> </maml:description> <command:parameterValue required="false">Id, Name or Object</command:parameterValue> <dev:type> <maml:name>Id, Name or Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermGroup</maml:name> <maml:description> <maml:para>Name of the term group to check.</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TermGroup</command:parameterValue> <dev:type> <maml:name>Id, Title or TermGroup</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStore</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="false">Id, Name or Object</command:parameterValue> <dev:type> <maml:name>Id, Name or Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Taxonomy.TermSet</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTermSet -TermGroup "Corporate"</dev:code> <maml:remarks> <maml:para>Returns all termsets in the group "Corporate" from the site collection termstore</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTermSet -Identity "Departments" -TermGroup "Corporate"</dev:code> <maml:remarks> <maml:para>Returns the termset named "Departments" from the termgroup called "Corporate" from the site collection termstore</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTermSet -Identity ab2af486-e097-4b4a-9444-527b251f1f8d -TermGroup "Corporate</dev:code> <maml:remarks> <maml:para>Returns the termset with the given id from the termgroup called "Corporate" from the site collection termstore</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTheme</command:name> <maml:description> <maml:para>Returns the current theme/composed look of the current web.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTheme</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTheme</maml:name> <command:parameter required="false" position="named"> <maml:name>DetectCurrentComposedLook</maml:name> <maml:description> <maml:para>Specify this switch to not use the PnP Provisioning engine based composed look information but try to detect the current composed look as is.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>DetectCurrentComposedLook</maml:name> <maml:description> <maml:para>Specify this switch to not use the PnP Provisioning engine based composed look information but try to detect the current composed look as is.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OfficeDevPnP.Core.Entities.ThemeEntity</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTheme</dev:code> <maml:remarks> <maml:para>Returns the current composed look of the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTheme -DetectCurrentComposedLook</dev:code> <maml:remarks> <maml:para>Returns the current composed look of the current web, and will try to detect the currently applied composed look based upon the actual site. Without this switch the cmdlet will first check for the presence of a property bag variable called _PnP_ProvisioningTemplateComposedLookInfo that contains composed look information when applied through the provisioning engine or the Set-PnPTheme cmdlet.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPTimeZoneId</command:name> <maml:description> <maml:para>Returns a time zone ID</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPTimeZoneId</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>In order to create a new classic site you need to specify the timezone this site will use. Use the cmdlet to retrieve a list of possible values.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTimeZoneId</maml:name> <command:parameter required="false" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>A string to search for like 'Stockholm'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>A string to search for like 'Stockholm'</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<SharePointPnP.PowerShell.Commands.GetTimeZoneId+Zone></maml:name> <maml:uri /> <maml:description> <maml:para>Returns a list of matching zones. Use the ID property of the object for use in New-SPOTenantSite</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTimeZoneId</dev:code> <maml:remarks> <maml:para>This will return all time zone IDs in use by Office 365.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTimeZoneId -Match Stockholm</dev:code> <maml:remarks> <maml:para>This will return the time zone IDs for Stockholm</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPUnifiedAuditLog</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Gets unified audit logs from the Office 365 Management API. Requires the Azure Active Directory application permission 'ActivityFeed.Read'.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPUnifiedAuditLog</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPUnifiedAuditLog</maml:name> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Content type of logs to be retreived, should be one of the following: AzureActiveDirectory, Exchange, SharePoint, General, DLP.</maml:para> </maml:description> <command:parameterValue required="true">AuditContentType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Start time of logs to be retrieved. Start time and end time must both be specified (or both omitted) and must be less than or equal to 24 hours apart, with the start time prior to end time and start time no more than 7 days in the past.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>End time of logs to be retrieved. Start time and end time must both be specified (or both omitted) and must be less than or equal to 24 hours apart.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Content type of logs to be retrieved, should be one of the following: AzureActiveDirectory, Exchange, SharePoint, General, DLP.</maml:para> </maml:description> <command:parameterValue required="false">AuditContentType</command:parameterValue> <dev:type> <maml:name>AuditContentType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>End time of logs to be retrieved. Start time and end time must both be specified (or both omitted) and must be less than or equal to 24 hours apart.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Start time of logs to be retrieved. Start time and end time must both be specified (or both omitted) and must be less than or equal to 24 hours apart, with the start time prior to end time and start time no more than 7 days in the past.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUnifiedAuditLog -ContentType SharePoint -StartTime (Get-Date).AddDays(-1) -EndTime (Get-Date).AddDays(-2)</dev:code> <maml:remarks> <maml:para>Retrieves the audit logs of SharePoint happening between the current time yesterday and the current time the day before yesterday</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPUnifiedGroup</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Gets one Office 365 Group (aka Unified Group) or a list of Office 365 Groups. Requires the Azure Active Directory application permission 'Group.Read.All'.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPUnifiedGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPUnifiedGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExcludeSiteUrl</maml:name> <maml:description> <maml:para>Exclude fetching the site URL for Office 365 Groups. This speeds up large listings.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeClassification</maml:name> <maml:description> <maml:para>Include Classification value of Office 365 Groups.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ExcludeSiteUrl</maml:name> <maml:description> <maml:para>Exclude fetching the site URL for Office 365 Groups. This speeds up large listings.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="false">UnifiedGroupPipeBind</command:parameterValue> <dev:type> <maml:name>UnifiedGroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeClassification</maml:name> <maml:description> <maml:para>Include Classification value of Office 365 Groups.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUnifiedGroup</dev:code> <maml:remarks> <maml:para>Retrieves all the Office 365 Groups</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUnifiedGroup -Identity $groupId</dev:code> <maml:remarks> <maml:para>Retrieves a specific Office 365 Group based on its ID</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUnifiedGroup -Identity $groupDisplayName</dev:code> <maml:remarks> <maml:para>Retrieves a specific or list of Office 365 Groups that start with the given DisplayName</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUnifiedGroup -Identity $groupSiteMailNickName</dev:code> <maml:remarks> <maml:para>Retrieves a specific or list of Office 365 Groups for which the email starts with the provided mail nickName</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUnifiedGroup -Identity $group</dev:code> <maml:remarks> <maml:para>Retrieves a specific Office 365 Group based on its object instance</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPUnifiedGroupMembers</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Gets members of a particular Office 365 Group (aka Unified Group). Requires the Azure Active Directory application permissions 'Group.Read.All' and 'User.Read.All'.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPUnifiedGroupMembers</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPUnifiedGroupMembers</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> <dev:type> <maml:name>UnifiedGroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUnifiedGroupMembers -Identity $groupId</dev:code> <maml:remarks> <maml:para>Retrieves all the members of a specific Office 365 Group based on its ID</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUnifiedGroupMembers -Identity $group</dev:code> <maml:remarks> <maml:para>Retrieves all the members of a specific Office 365 Group based on the group's object instance</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPUnifiedGroupOwners</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Gets owners of a particular Office 365 Group (aka Unified Group). Requires the Azure Active Directory application permissions 'Group.Read.All' and 'User.Read.All'.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPUnifiedGroupOwners</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPUnifiedGroupOwners</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> <dev:type> <maml:name>UnifiedGroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUnifiedGroupOwners -Identity $groupId</dev:code> <maml:remarks> <maml:para>Retrieves all the owners of a specific Office 365 Group based on its ID</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUnifiedGroupOwners -Identity $group</dev:code> <maml:remarks> <maml:para>Retrieves all the owners of a specific Office 365 Group based on the group's object instance</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPUPABulkImportStatus</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Get user profile bulk import status.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPUPABulkImportStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieve information about the status of submitted user profile bulk upload jobs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPUPABulkImportStatus</maml:name> <command:parameter required="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>The instance id of the job</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeErrorDetails</maml:name> <maml:description> <maml:para>Include error log details</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>IncludeErrorDetails</maml:name> <maml:description> <maml:para>Include error log details</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>JobId</maml:name> <maml:description> <maml:para>The instance id of the job</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUPABulkImportStatus</dev:code> <maml:remarks> <maml:para>This will list the status of all submitted user profile bulk import jobs.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUPABulkImportStatus -IncludeErrorDetails</dev:code> <maml:remarks> <maml:para>This will list the status of all submitted user profile bulk import jobs, and if it contains an error it will include the error log messages if present.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUPABulkImportStatus -JobId <guid></dev:code> <maml:remarks> <maml:para>This will list the status for the specified import job.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUPABulkImportStatus -JobId <guid> -IncludeErrorDetails</dev:code> <maml:remarks> <maml:para>This will list the status for the specified import job, and if it contains an error it will include the error log messages if present.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPUser</command:name> <maml:description> <maml:para>Returns site users of current web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command will return all users that exist in the current site collection's User Information List</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPUser</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>User ID or login name</maml:para> </maml:description> <command:parameterValue required="true">UserPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>WithRightsAssigned</maml:name> <maml:description> <maml:para>If provided, only users that currently have any kinds of access rights assigned to the current site collection will be returned. Otherwise all users, even those who previously had rights assigned, but not anymore at the moment, will be returned as the information is pulled from the User Information List. Only works if you don't provide an -Identity.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>User ID or login name</maml:para> </maml:description> <command:parameterValue required="false">UserPipeBind</command:parameterValue> <dev:type> <maml:name>UserPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>WithRightsAssigned</maml:name> <maml:description> <maml:para>If provided, only users that currently have any kinds of access rights assigned to the current site collection will be returned. Otherwise all users, even those who previously had rights assigned, but not anymore at the moment, will be returned as the information is pulled from the User Information List. Only works if you don't provide an -Identity.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.User</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUser</dev:code> <maml:remarks> <maml:para>Returns all users from the User Information List of the current site collection regardless if they currently have rights to access the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUser -Identity 23</dev:code> <maml:remarks> <maml:para>Returns the user with Id 23 from the User Information List of the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUser -Identity "i:0#.f|membership|user@tenant.onmicrosoft.com"</dev:code> <maml:remarks> <maml:para>Returns the user with LoginName i:0#.f|membership|user@tenant.onmicrosoft.com from the User Information List of the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUser | ? Email -eq "user@tenant.onmicrosoft.com"</dev:code> <maml:remarks> <maml:para>Returns the user with e-mail address user@tenant.onmicrosoft.com from the User Information List of the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUser -WithRightsAssigned</dev:code> <maml:remarks> <maml:para>Returns only those users from the User Information List of the current site collection who currently have any kind of access rights given either directly to the user or Active Directory Group or given to the user or Active Directory Group via membership of a SharePoint Group to the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUser -WithRightsAssigned -Web subsite1</dev:code> <maml:remarks> <maml:para>Returns only those users from the User Information List of the current site collection who currently have any kind of access rights given either directly to the user or Active Directory Group or given to the user or Active Directory Group via membership of a SharePoint Group to subsite 'subsite1'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPUserProfileProperty</command:name> <maml:description> <maml:para>You must connect to the tenant admin website (https://:<tenant>-admin.sharepoint.com) with Connect-PnPOnline in order to use this cmdlet. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPUserProfileProperty</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Requires a connection to a SharePoint Tenant Admin site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPUserProfileProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>Account</maml:name> <maml:description> <maml:para>The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Account</maml:name> <maml:description> <maml:para>The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.UserProfiles.PersonProperties</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUserProfileProperty -Account 'user@domain.com'</dev:code> <maml:remarks> <maml:para>Returns the profile properties for the specified user</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUserProfileProperty -Account 'user@domain.com','user2@domain.com'</dev:code> <maml:remarks> <maml:para>Returns the profile properties for the specified users</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPView</command:name> <maml:description> <maml:para>Returns one or all views from a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPView</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPView</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or name of the view</maml:para> </maml:description> <command:parameterValue required="true">ViewPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or name of the view</maml:para> </maml:description> <command:parameterValue required="false">ViewPipeBind</command:parameterValue> <dev:type> <maml:name>ViewPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.View</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-PnPView -List "Demo List"</dev:code> <maml:remarks> <maml:para>Returns all views associated from the specified list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-PnPView -List "Demo List" -Identity "Demo View"</dev:code> <maml:remarks> <maml:para>Returns the view called "Demo View" from the specified list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-PnPView -List "Demo List" -Identity "5275148a-6c6c-43d8-999a-d2186989a661"</dev:code> <maml:remarks> <maml:para>Returns the view with the specified ID from the specified list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPWeb</command:name> <maml:description> <maml:para>Returns the current web object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPWeb</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPWeb</maml:name> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The guid of the web or web object</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The guid of the web or web object</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Web</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWeb</dev:code> <maml:remarks> <maml:para>This will return the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPWebhookSubscriptions</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Gets all the Webhook subscriptions of the resource</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPWebhookSubscriptions</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPWebhookSubscriptions</maml:name> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name to get the Webhook subscriptions from</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name to get the Webhook subscriptions from</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OfficeDevPnP.Core.Entities.WebhookSubscription</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWebhookSubscriptions -List MyList</dev:code> <maml:remarks> <maml:para>Gets all Webhook subscriptions of the list MyList</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPWebPart</command:name> <maml:description> <maml:para>Returns a web part definition object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPWebPart</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPWebPart</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative URL of the web part page, e.g. /sites/mysite/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the web part, this can be the web part guid or a web part object</maml:para> </maml:description> <command:parameterValue required="true">WebPartPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the web part, this can be the web part guid or a web part object</maml:para> </maml:description> <command:parameterValue required="false">WebPartPipeBind</command:parameterValue> <dev:type> <maml:name>WebPartPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative URL of the web part page, e.g. /sites/mysite/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<Microsoft.SharePoint.Client.WebParts.WebPartDefinition></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx"</dev:code> <maml:remarks> <maml:para>Returns all webparts defined on the given page.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82</dev:code> <maml:remarks> <maml:para>Returns a specific web part defined on the given page.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPWebPartProperty</command:name> <maml:description> <maml:para>Returns a web part property</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPWebPartProperty</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPWebPartProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative URL of the web part page, e.g. /sites/mysite/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the web part</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Name of a single property to be returned</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the web part</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Name of a single property to be returned</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative URL of the web part page, e.g. /sites/mysite/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914</dev:code> <maml:remarks> <maml:para>Returns all properties of the web part.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914 -Key "Title"</dev:code> <maml:remarks> <maml:para>Returns the title property of the web part.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPWebPartXml</command:name> <maml:description> <maml:para>Returns the web part XML of a web part registered on a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPWebPartXml</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPWebPartXml</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the web part page, e.g. /sites/mysite/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id or title of the web part. Use Get-PnPWebPart to retrieve all web part Ids</maml:para> </maml:description> <command:parameterValue required="true">WebPartPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id or title of the web part. Use Get-PnPWebPart to retrieve all web part Ids</maml:para> </maml:description> <command:parameterValue required="true">WebPartPipeBind</command:parameterValue> <dev:type> <maml:name>WebPartPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the web part page, e.g. /sites/mysite/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWebPartXml -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82</dev:code> <maml:remarks> <maml:para>Returns the web part XML for a given web part on a page.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPWebTemplates</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Returns the available web templates.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPWebTemplates</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Will list all available templates one can use to create a classic site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPWebTemplates</maml:name> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>The language ID. For instance: 1033 for English</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CompatibilityLevel</maml:name> <maml:description> <maml:para>The version of SharePoint</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>CompatibilityLevel</maml:name> <maml:description> <maml:para>The version of SharePoint</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>The language ID. For instance: 1033 for English</maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Online.SharePoint.TenantAdministration.SPOTenantWebTemplateCollection</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWebTemplates</dev:code> <maml:remarks> <maml:para /> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWebTemplates -LCID 1033</dev:code> <maml:remarks> <maml:para>Returns all webtemplates for the Locale with ID 1033 (English)</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWebTemplates -CompatibilityLevel 15</dev:code> <maml:remarks> <maml:para>Returns all webtemplates for the compatibility level 15</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Locale IDs:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPWikiPageContent</command:name> <maml:description> <maml:para>Gets the contents/source of a wiki page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPWikiPageContent</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPWikiPageContent</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>The server relative URL for the wiki page</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>The server relative URL for the wiki page</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWikiPageContent -PageUrl '/sites/demo1/pages/wikipage.aspx'</dev:code> <maml:remarks> <maml:para>Gets the content of the page '/sites/demo1/pages/wikipage.aspx'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPWorkflowDefinition</command:name> <maml:description> <maml:para>Returns a workflow definition</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPWorkflowDefinition</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns a workflow definition</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPWorkflowDefinition</maml:name> <command:parameter required="false" position="named"> <maml:name>PublishedOnly</maml:name> <maml:description> <maml:para>Return only the published workflows</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the workflow</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the workflow</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublishedOnly</maml:name> <maml:description> <maml:para>Return only the published workflows</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.WorkflowServices.WorkflowDefinition</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWorkflowDefinition -Name MyWorkflow</dev:code> <maml:remarks> <maml:para>Gets a Workflow with the name "MyWorkflow".</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWorkflowDefinition -Name MyWorkflow -PublishedOnly $false</dev:code> <maml:remarks> <maml:para>Gets a Workflow with the name "MyWorkflow" that is published.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPWorkflowInstance</command:name> <maml:description> <maml:para>Get workflow instances</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPWorkflowInstance</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets all workflow instances</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPWorkflowInstance</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The List for which workflow instances should be retrieved</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ListItem</maml:name> <maml:description> <maml:para>The List Item for which workflow instances should be retrieved</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The List for which workflow instances should be retrieved</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ListItem</maml:name> <maml:description> <maml:para>The List Item for which workflow instances should be retrieved</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> <dev:type> <maml:name>ListItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWorkflowInstance -List "My Library" -ListItem $ListItem</dev:code> <maml:remarks> <maml:para>Retrieves workflow instances running against the provided item on list "My Library"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWorkflowInstance -List "My Library" -ListItem 2</dev:code> <maml:remarks> <maml:para>Retrieves workflow instances running against the provided item with 2 in the list "My Library"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PnPWorkflowSubscription</command:name> <maml:description> <maml:para>Return a workflow subscription</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPWorkflowSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns a workflow subscriptions from a list</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPWorkflowSubscription</maml:name> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the workflow</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>A list to search the association for</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>A list to search the association for</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the workflow</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.WorkflowServices.WorkflowSubscription</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWorkflowSubscription -Name MyWorkflow</dev:code> <maml:remarks> <maml:para>Gets an Workflow subscription with the name "MyWorkflow".</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWorkflowSubscription -Name MyWorkflow -list $list</dev:code> <maml:remarks> <maml:para>Gets an Workflow subscription with the name "MyWorkflow" from the list $list.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPList -identity "MyList" | Get-PnPWorkflowSubscription -Name MyWorkflow</dev:code> <maml:remarks> <maml:para>Gets an Workflow subscription with the name "MyWorkflow" from the list "MyList".</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Grant-PnPHubSiteRights</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Grant additional permissions to the permissions already in place to associate sites to Hub Sites for one or more specific users</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Grant</command:verb> <command:noun>PnPHubSiteRights</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Grant-PnPHubSiteRights</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Grant-PnPHubSiteRights -Identity https://contoso.sharepoint.com/sites/hubsite -Principals "myuser@mydomain.com","myotheruser@mydomain.com"</dev:code> <maml:remarks> <maml:para>This example shows how to grant rights to myuser and myotheruser to associate their sites with the provided Hub Site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Grant-PnPSiteDesignRights</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Grants the specified principals rights to use the site design.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Grant</command:verb> <command:noun>PnPSiteDesignRights</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Grant-PnPSiteDesignRights</maml:name> <command:parameter required="true" position="named"> <maml:name>Principals</maml:name> <maml:description> <maml:para>One or more principals to grant rights to.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The site design to use.</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Rights</maml:name> <maml:description> <maml:para>The rights to set. Defaults to 'View'</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPrincipalRights</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The site design to use.</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> <dev:type> <maml:name>TenantSiteDesignPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Principals</maml:name> <maml:description> <maml:para>One or more principals to grant rights to.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Rights</maml:name> <maml:description> <maml:para>The rights to set. Defaults to 'View'</maml:para> </maml:description> <command:parameterValue required="false">TenantSiteDesignPrincipalRights</command:parameterValue> <dev:type> <maml:name>TenantSiteDesignPrincipalRights</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Grant-PnPSiteDesignRights -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -Principals "myuser@mydomain.com","myotheruser@mydomain.com"</dev:code> <maml:remarks> <maml:para>Grants the specified principals View rights on the site design specified</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteDesign -Title "MySiteDesign" -SiteScriptIds 438548fd-60dd-42cf-b843-2db506c8e259 -WebTemplate TeamSite | Grant-PnPSiteDesignRights -Principals "myuser@mydomain.com","myotheruser@mydomain.com"</dev:code> <maml:remarks> <maml:para>Grants the specified principals View rights on the site design specified</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Grant-PnPTenantServicePrincipalPermission</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Explicitly grants a specified permission to the "SharePoint Online Client" service principal</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Grant</command:verb> <command:noun>PnPTenantServicePrincipalPermission</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Grant-PnPTenantServicePrincipalPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope to grant the permission for</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The resource to grant the permission for</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The resource to grant the permission for</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope to grant the permission for</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OfficeDevPnP.Core.ALM.AppMetadata</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Grant-PnPTenantServicePrincipalPermission -Scope "Group.Read.All" -Resource "Microsoft Graph"</dev:code> <maml:remarks> <maml:para>This will explicitly grant the Group.Read.All permission on the Microsoft Graph resource</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Import-PnPAppPackage</command:name> <maml:description> <maml:para>Adds a SharePoint Addin to a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>PnPAppPackage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This commands requires that you have an addin package to deploy</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-PnPAppPackage</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path pointing to the .app file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Will forcibly install the app by activating the addin sideloading feature, installing the addin, and deactivating the sideloading feature</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LoadOnly</maml:name> <maml:description> <maml:para>Will only upload the addin, but not install it</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Locale</maml:name> <maml:description> <maml:para>Will install the addin for the specified locale</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Will forcibly install the app by activating the addin sideloading feature, installing the addin, and deactivating the sideloading feature</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LoadOnly</maml:name> <maml:description> <maml:para>Will only upload the addin, but not install it</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Locale</maml:name> <maml:description> <maml:para>Will install the addin for the specified locale</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path pointing to the .app file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.AppInstance</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-PnPAppPackage -Path c:\files\demo.app -LoadOnly</dev:code> <maml:remarks> <maml:para>This will load the addin in the demo.app package, but will not install it to the site. </maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-PnPAppPackage -Path c:\files\demo.app -Force</dev:code> <maml:remarks> <maml:para>This load first activate the addin sideloading feature, upload and install the addin, and deactivate the addin sideloading feature. </maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Import-PnPTaxonomy</command:name> <maml:description> <maml:para>Imports a taxonomy from either a string array or a file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>PnPTaxonomy</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Import-PnPTaxonomy</maml:name> <command:parameter required="false" position="named"> <maml:name>Terms</maml:name> <maml:description> <maml:para>An array of strings describing termgroup, termset, term, subterms using a default delimiter of '|'.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to import to; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para>The path delimiter to be used, by default this is '|'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SynchronizeDeletions</maml:name> <maml:description> <maml:para>If specified, terms that exist in the termset, but are not in the imported data, will be removed.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-PnPTaxonomy</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies a file containing terms per line, in the format as required by the Terms parameter.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to import to; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para>The path delimiter to be used, by default this is '|'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SynchronizeDeletions</maml:name> <maml:description> <maml:para>If specified, terms that exist in the termset, but are not in the imported data, will be removed.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para>The path delimiter to be used, by default this is '|'</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies a file containing terms per line, in the format as required by the Terms parameter.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SynchronizeDeletions</maml:name> <maml:description> <maml:para>If specified, terms that exist in the termset, but are not in the imported data, will be removed.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Terms</maml:name> <maml:description> <maml:para>An array of strings describing termgroup, termset, term, subterms using a default delimiter of '|'.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to import to; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-PnPTaxonomy -Terms 'Company|Locations|Stockholm'</dev:code> <maml:remarks> <maml:para>Creates a new termgroup, 'Company', a termset 'Locations' and a term 'Stockholm'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-PnPTaxonomy -Terms 'Company|Locations|Stockholm|Central','Company|Locations|Stockholm|North'</dev:code> <maml:remarks> <maml:para>Creates a new termgroup, 'Company', a termset 'Locations', a term 'Stockholm' and two subterms: 'Central', and 'North'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-PnPTaxonomy -Path ./mytaxonomyterms.txt</dev:code> <maml:remarks> <maml:para>Imports the taxonomy from the file specified. Each line has to be in the format TERMGROUP|TERMSET|TERM. See example 2 for examples of the format.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Import-PnPTermGroupFromXml</command:name> <maml:description> <maml:para>Imports a taxonomy TermGroup from either the input or from an XML file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>PnPTermGroupFromXml</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Import-PnPTermGroupFromXml</maml:name> <command:parameter required="false" position="named"> <maml:name>Xml</maml:name> <maml:description> <maml:para>The XML to process</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-PnPTermGroupFromXml</maml:name> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>The XML File to import the data from</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>The XML File to import the data from</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Xml</maml:name> <maml:description> <maml:para>The XML to process</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-PnPTermGroupFromXml -Xml $xml</dev:code> <maml:remarks> <maml:para>Imports the XML based termgroup information located in the $xml variable</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-PnPTermGroupFromXml -Path input.xml</dev:code> <maml:remarks> <maml:para>Imports the XML file specified by the path.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Import-PnPTermSet</command:name> <maml:description> <maml:para>Imports a taxonomy term set from a file in the standard format.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>PnPTermSet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The format of the file is the same as that used by the import function in the web interface. A sample file can be obtained from the web interface. This is a CSV file, with the following headings: Term Set Name,Term Set Description,LCID,Available for Tagging,Term Description,Level 1 Term,Level 2 Term,Level 3 Term,Level 4 Term,Level 5 Term,Level 6 Term,Level 7 Term The first data row must contain the Term Set Name, Term Set Description, and LCID, and should also contain the first term. It is recommended that a fixed GUID be used as the termSetId, to allow the term set to be easily updated (so do not pass Guid.Empty). In contrast to the web interface import, this is not a one-off import but runs synchronization logic allowing updating of an existing Term Set. When synchronizing, any existing terms are matched (with Term Description and Available for Tagging updated as necessary), any new terms are added in the correct place in the hierarchy, and (if synchronizeDeletions is set) any terms not in the imported file are removed. The import file also supports an expanded syntax for the Term Set Name and term names (Level 1 Term, Level 2 Term, etc). These columns support values with the format 'Name | GUID', with the name and GUID separated by a pipe character (note that the pipe character is invalid to use within a taxonomy item name). This expanded syntax is not required, but can be used to ensure all terms have fixed IDs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-PnPTermSet</maml:name> <command:parameter required="true" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Group to import the term set to; an error is returned if the group does not exist.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Local path to the file containing the term set to import, in the standard format (as the 'sample import file' available in the Term Store Administration).</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermSetId</maml:name> <maml:description> <maml:para>GUID to use for the term set; if not specified, or the empty GUID, a random GUID is generated and used.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SynchronizeDeletions</maml:name> <maml:description> <maml:para>If specified, the import will remove any terms (and children) previously in the term set but not in the import file; default is to leave them.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsOpen</maml:name> <maml:description> <maml:para>Whether the term set should be marked open; if not specified, then the existing setting is not changed.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Contact</maml:name> <maml:description> <maml:para>Contact for the term set; if not specified, the existing setting is retained.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Owner for the term set; if not specified, the existing setting is retained.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to import into; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Contact</maml:name> <maml:description> <maml:para>Contact for the term set; if not specified, the existing setting is retained.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Group to import the term set to; an error is returned if the group does not exist.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsOpen</maml:name> <maml:description> <maml:para>Whether the term set should be marked open; if not specified, then the existing setting is not changed.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Owner for the term set; if not specified, the existing setting is retained.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Local path to the file containing the term set to import, in the standard format (as the 'sample import file' available in the Term Store Administration).</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SynchronizeDeletions</maml:name> <maml:description> <maml:para>If specified, the import will remove any terms (and children) previously in the term set but not in the import file; default is to leave them.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermSetId</maml:name> <maml:description> <maml:para>GUID to use for the term set; if not specified, or the empty GUID, a random GUID is generated and used.</maml:para> </maml:description> <command:parameterValue required="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to import into; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-PnPTermSet -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -SynchronizeDeletions</dev:code> <maml:remarks> <maml:para>Creates (or updates) the term set specified in the import file, in the group specified, removing any existing terms not in the file.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-PnPTermSet -TermStoreName 'My Term Store' -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -TermSetId '{15A98DB6-D8E2-43E6-8771-066C1EC2B8D8}' </dev:code> <maml:remarks> <maml:para>Creates (or updates) the term set specified in the import file, in the term store and group specified, using the specified ID.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Import-PnPTermSet -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -IsOpen $true -Contact 'user@example.org' -Owner 'user@example.org'</dev:code> <maml:remarks> <maml:para>Creates (or updates) the term set specified in the import file, setting the IsOpen, Contact, and Owner properties as specified.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Install-PnPApp</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Installs an available app from the app catalog</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>PnPApp</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Install-PnPApp</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id or an actual app metadata instance</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="true">AppCatalogScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If specified the execution will pause until the app has been installed in the site.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id or an actual app metadata instance</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> <dev:type> <maml:name>AppMetadataPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="false">AppCatalogScope</command:parameterValue> <dev:type> <maml:name>AppCatalogScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If specified the execution will pause until the app has been installed in the site.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Install-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>This will install an app that is available in the tenant scoped app catalog, specified by the id, to the current site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Install-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site</dev:code> <maml:remarks> <maml:para>This will install an app that is available in the site collection scoped app catalog, specified by the id, to the current site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe | Install-PnPApp</dev:code> <maml:remarks> <maml:para>This will install the given app from the tenant scoped app catalog into the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site | Install-PnPApp</dev:code> <maml:remarks> <maml:para>This will install the given app from the site collection scoped app catalog into the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Install-PnPSolution</command:name> <maml:description> <maml:para>Installs a sandboxed solution to a site collection. WARNING! This method can delete your composed look gallery due to the method used to activate the solution. We recommend you to only to use this cmdlet if you are okay with that.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>PnPSolution</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Install-PnPSolution</maml:name> <command:parameter required="true" position="named"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>ID of the solution, from the solution manifest</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the sandbox solution package (.WSP) file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MajorVersion</maml:name> <maml:description> <maml:para>Optional major version of the solution, defaults to 1</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinorVersion</maml:name> <maml:description> <maml:para>Optional minor version of the solution, defaults to 0</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>MajorVersion</maml:name> <maml:description> <maml:para>Optional major version of the solution, defaults to 1</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinorVersion</maml:name> <maml:description> <maml:para>Optional minor version of the solution, defaults to 0</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>ID of the solution, from the solution manifest</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SourceFilePath</maml:name> <maml:description> <maml:para>Path to the sandbox solution package (.WSP) file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Install-PnPSolution -PackageId c2f5b025-7c42-4d3a-b579-41da3b8e7254 -SourceFilePath mypackage.wsp</dev:code> <maml:remarks> <maml:para>Installs the package to the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-PnPQuery</command:name> <maml:description> <maml:para>Executes the currently queued actions</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>PnPQuery</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Executes any queued actions / changes on the SharePoint Client Side Object Model Context</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-PnPQuery</maml:name> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Number of times to retry in case of throttling. Defaults to 10.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Delay in seconds. Defaults to 1.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>Number of times to retry in case of throttling. Defaults to 10.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetryWait</maml:name> <maml:description> <maml:para>Delay in seconds. Defaults to 1.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Invoke-PnPQuery -RetryCount 5</dev:code> <maml:remarks> <maml:para>This will execute any queued actions / changes on the SharePoint Client Side Object Model Context and will retry 5 times in case of throttling.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Invoke-PnPQuery -RetryWait 10</dev:code> <maml:remarks> <maml:para>This will execute any queued actions / changes on the SharePoint Client Side Object Model Context and delay the execution for 10 seconds before it retries the execution.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-PnPSiteDesign</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Apply a Site Design to an existing site. * Requires Tenant Administration Rights *</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>PnPSiteDesign</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Invoke-PnPSiteDesign</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Site Design Id or an actual Site Design object to apply</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the web to apply the site design to. If not specified it will default to the current web based upon the URL specified with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Site Design Id or an actual Site Design object to apply</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> <dev:type> <maml:name>TenantSiteDesignPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the web to apply the site design to. If not specified it will default to the current web based upon the URL specified with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Invoke-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd</dev:code> <maml:remarks> <maml:para>Applies the specified site design to the current site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Invoke-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -WebUrl https://contoso.sharepoint.com/sites/mydemosite</dev:code> <maml:remarks> <maml:para>Applies the specified site design to the specified site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteDesign | ?{$_.Title -eq "Demo"} | Invoke-PnPSiteDesign</dev:code> <maml:remarks> <maml:para>Applies the specified site design to the specified site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-PnPSPRestMethod</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Invokes a REST request towards a SharePoint site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>PnPSPRestMethod</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Invokes a REST request towards a SharePoint site</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-PnPSPRestMethod</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The url to execute.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para>A string or object to send</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type of the object to send. Defaults to 'application/json'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Method</maml:name> <maml:description> <maml:para>The Http method to execute. Defaults to GET.</maml:para> </maml:description> <command:parameterValue required="true">HttpRequestMethod</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para>A string or object to send</maml:para> </maml:description> <command:parameterValue required="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type of the object to send. Defaults to 'application/json'</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Method</maml:name> <maml:description> <maml:para>The Http method to execute. Defaults to GET.</maml:para> </maml:description> <command:parameterValue required="false">HttpRequestMethod</command:parameterValue> <dev:type> <maml:name>HttpRequestMethod</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The url to execute.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Invoke-PnPSPRestMethod -Url /_api/web</dev:code> <maml:remarks> <maml:para>This example executes a GET request towards the current site collection and returns the properties of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $output = Invoke-PnPSPRestMethod -Url '/_api/web/lists?$select=Id,Title' PS:> $output.value</dev:code> <maml:remarks> <maml:para>This example executes a GET request towards the current site collection and returns the id and title of all the lists and outputs them to the console. Notice the use of single quotes. If you want to use double quotes (") then you will have to escape the $ character with a backtick: `$</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $item = @{Title="Test"} PS:> Invoke-PnPSPRestMethod -Method Post -Url "/_api/web/lists/GetByTitle('Test')/items" -Content $item</dev:code> <maml:remarks> <maml:para>This example creates a new item in the list 'Test' and sets the title field to 'Test'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $item = "{'Title':'Test'}" PS:> Invoke-PnPSPRestMethod -Method Post -Url "/_api/web/lists/GetByTitle('Test')/items" -Content $item</dev:code> <maml:remarks> <maml:para>This example creates a new item in the list 'Test' and sets the title field to 'Test'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $item = "{ '__metadata': { 'type': 'SP.Data.TestListItem' }, 'Title': 'Test'}" PS:> Invoke-PnPSPRestMethod -Method Post -Url "/_api/web/lists/GetByTitle('Test')/items" -Content $item -ContentType "application/json;odata=verbose"</dev:code> <maml:remarks> <maml:para>This example creates a new item in the list 'Test' and sets the title field to 'Test'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-PnPWebAction</command:name> <maml:description> <maml:para>Executes operations on web, lists and list items.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>PnPWebAction</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Invoke-PnPWebAction</maml:name> <command:parameter required="false" position="named"> <maml:name>Webs</maml:name> <maml:description> <maml:para>Webs you want to process (for example different site collections), will use Web parameter if not specified</maml:para> </maml:description> <command:parameterValue required="true">Web[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebAction</maml:name> <maml:description> <maml:para>Function to be executed on the web. There is one input parameter of type Web</maml:para> </maml:description> <command:parameterValue required="true">Web</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessWebAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would determine if WebAction should be invoked, There is one input parameter of type Web and the function should return a boolean value</maml:para> </maml:description> <command:parameterValue required="true">Web</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PostWebAction</maml:name> <maml:description> <maml:para>Function to be executed on the web, this will trigger after lists and list items have been processed. There is one input parameter of type Web</maml:para> </maml:description> <command:parameterValue required="true">Web</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessPostWebAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would determine if PostWebAction should be invoked, There is one input parameter of type Web and the function should return a boolean value</maml:para> </maml:description> <command:parameterValue required="true">Web</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebProperties</maml:name> <maml:description> <maml:para>The properties to load for web.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListAction</maml:name> <maml:description> <maml:para>Function to be executed on the list. There is one input parameter of type List</maml:para> </maml:description> <command:parameterValue required="true">List</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessListAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would determine if ListAction should be invoked, There is one input parameter of type List and the function should return a boolean value</maml:para> </maml:description> <command:parameterValue required="true">List</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PostListAction</maml:name> <maml:description> <maml:para>Function to be executed on the list, this will trigger after list items have been processed. There is one input parameter of type List</maml:para> </maml:description> <command:parameterValue required="true">List</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessPostListAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would determine if PostListAction should be invoked, There is one input parameter of type List and the function should return a boolean value</maml:para> </maml:description> <command:parameterValue required="true">List</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListProperties</maml:name> <maml:description> <maml:para>The properties to load for list.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListItemAction</maml:name> <maml:description> <maml:para>Function to be executed on the list item. There is one input parameter of type ListItem</maml:para> </maml:description> <command:parameterValue required="true">ListItem</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessListItemAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would determine if ListItemAction should be invoked, There is one input parameter of type ListItem and the function should return a boolean value</maml:para> </maml:description> <command:parameterValue required="true">ListItem</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListItemProperties</maml:name> <maml:description> <maml:para>The properties to load for list items.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SubWebs</maml:name> <maml:description> <maml:para>Specify if sub webs will be processed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableStatisticsOutput</maml:name> <maml:description> <maml:para>Will not output statistics after the operation</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipCounting</maml:name> <maml:description> <maml:para>Will skip the counting process; by doing this you will not get an estimated time remaining</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>DisableStatisticsOutput</maml:name> <maml:description> <maml:para>Will not output statistics after the operation</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListAction</maml:name> <maml:description> <maml:para>Function to be executed on the list. There is one input parameter of type List</maml:para> </maml:description> <command:parameterValue required="false">List</command:parameterValue> <dev:type> <maml:name>List</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListItemAction</maml:name> <maml:description> <maml:para>Function to be executed on the list item. There is one input parameter of type ListItem</maml:para> </maml:description> <command:parameterValue required="false">ListItem</command:parameterValue> <dev:type> <maml:name>ListItem</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListItemProperties</maml:name> <maml:description> <maml:para>The properties to load for list items.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListProperties</maml:name> <maml:description> <maml:para>The properties to load for list.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PostListAction</maml:name> <maml:description> <maml:para>Function to be executed on the list, this will trigger after list items have been processed. There is one input parameter of type List</maml:para> </maml:description> <command:parameterValue required="false">List</command:parameterValue> <dev:type> <maml:name>List</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PostWebAction</maml:name> <maml:description> <maml:para>Function to be executed on the web, this will trigger after lists and list items have been processed. There is one input parameter of type Web</maml:para> </maml:description> <command:parameterValue required="false">Web</command:parameterValue> <dev:type> <maml:name>Web</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessListAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would determine if ListAction should be invoked, There is one input parameter of type List and the function should return a boolean value</maml:para> </maml:description> <command:parameterValue required="false">List</command:parameterValue> <dev:type> <maml:name>List</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessListItemAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would determine if ListItemAction should be invoked, There is one input parameter of type ListItem and the function should return a boolean value</maml:para> </maml:description> <command:parameterValue required="false">ListItem</command:parameterValue> <dev:type> <maml:name>ListItem</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessPostListAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would determine if PostListAction should be invoked, There is one input parameter of type List and the function should return a boolean value</maml:para> </maml:description> <command:parameterValue required="false">List</command:parameterValue> <dev:type> <maml:name>List</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessPostWebAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would determine if PostWebAction should be invoked, There is one input parameter of type Web and the function should return a boolean value</maml:para> </maml:description> <command:parameterValue required="false">Web</command:parameterValue> <dev:type> <maml:name>Web</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldProcessWebAction</maml:name> <maml:description> <maml:para>Function to be executed on the web that would determine if WebAction should be invoked, There is one input parameter of type Web and the function should return a boolean value</maml:para> </maml:description> <command:parameterValue required="false">Web</command:parameterValue> <dev:type> <maml:name>Web</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipCounting</maml:name> <maml:description> <maml:para>Will skip the counting process; by doing this you will not get an estimated time remaining</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SubWebs</maml:name> <maml:description> <maml:para>Specify if sub webs will be processed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebAction</maml:name> <maml:description> <maml:para>Function to be executed on the web. There is one input parameter of type Web</maml:para> </maml:description> <command:parameterValue required="false">Web</command:parameterValue> <dev:type> <maml:name>Web</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebProperties</maml:name> <maml:description> <maml:para>The properties to load for web.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Webs</maml:name> <maml:description> <maml:para>Webs you want to process (for example different site collections), will use Web parameter if not specified</maml:para> </maml:description> <command:parameterValue required="false">Web[]</command:parameterValue> <dev:type> <maml:name>Web[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Invoke-PnPWebAction -ListAction ${function:ListAction}</dev:code> <maml:remarks> <maml:para>This will call the function ListAction on all the lists located on the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Invoke-PnPWebAction -ShouldProcessListAction ${function:ShouldProcessList} -ListAction ${function:ListAction}</dev:code> <maml:remarks> <maml:para>This will call the function ShouldProcessList, if it returns true the function ListAction will then be called. This will occur on all lists located on the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Measure-PnPList</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2016, SharePoint 2019. Returns statistics on the list object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Measure</command:verb> <command:noun>PnPList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Measure-PnPList</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ItemLevel</maml:name> <maml:description> <maml:para>Show item level statistics</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BrokenPermissions</maml:name> <maml:description> <maml:para>Show items with broken permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>BrokenPermissions</maml:name> <maml:description> <maml:para>Show items with broken permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ItemLevel</maml:name> <maml:description> <maml:para>Show item level statistics</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Measure-PnPList "Documents"</dev:code> <maml:remarks> <maml:para>Gets statistics on Documents document library</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Measure-PnPList "Documents" -BrokenPermissions -ItemLevel</dev:code> <maml:remarks> <maml:para>Displays items and folders with broken permissions inside Documents library</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Measure-PnPWeb</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2016, SharePoint 2019. Returns statistics on the web object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Measure</command:verb> <command:noun>PnPWeb</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Measure-PnPWeb</maml:name> <command:parameter required="false" position="named"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>Iterate all sub webs recursively</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeHiddenList</maml:name> <maml:description> <maml:para>Include hidden lists in statistics calculation</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IncludeHiddenList</maml:name> <maml:description> <maml:para>Include hidden lists in statistics calculation</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>Iterate all sub webs recursively</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Measure-PnPWeb</dev:code> <maml:remarks> <maml:para>Gets statistics on the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Measure-PnPWeb $web -Recursive</dev:code> <maml:remarks> <maml:para>Gets statistics on the provided web including all its subwebs</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Measure-PnPResponseTime</command:name> <maml:description> <maml:para>Gets statistics on response time for the specified endpoint by sending probe requests</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Measure</command:verb> <command:noun>PnPResponseTime</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Measure-PnPResponseTime</maml:name> <command:parameter required="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of probe requests to send</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WarmUp</maml:name> <maml:description> <maml:para>Number of warm up requests to send before start calculating statistics</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Idle timeout between requests to avoid request throttling</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Histogram</maml:name> <maml:description> <maml:para>Number of buckets in histogram in output statistics</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Response time measurement mode. RoundTrip - measures full request round trip. SPRequestDuration - measures server processing time only, based on SPRequestDuration HTTP header. Latency - difference between RoundTrip and SPRequestDuration</maml:para> </maml:description> <command:parameterValue required="true">MeasureResponseTimeMode</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">DiagnosticEndpointPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of probe requests to send</maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Histogram</maml:name> <maml:description> <maml:para>Number of buckets in histogram in output statistics</maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Response time measurement mode. RoundTrip - measures full request round trip. SPRequestDuration - measures server processing time only, based on SPRequestDuration HTTP header. Latency - difference between RoundTrip and SPRequestDuration</maml:para> </maml:description> <command:parameterValue required="false">MeasureResponseTimeMode</command:parameterValue> <dev:type> <maml:name>MeasureResponseTimeMode</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Idle timeout between requests to avoid request throttling</maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">DiagnosticEndpointPipeBind</command:parameterValue> <dev:type> <maml:name>DiagnosticEndpointPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WarmUp</maml:name> <maml:description> <maml:para>Number of warm up requests to send before start calculating statistics</maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Measure-PnPResponseTime -Count 100 -Timeout 20</dev:code> <maml:remarks> <maml:para>Calculates statistics on sequence of 100 probe requests, sleeps 20ms between probes</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Measure-PnPResponseTime "/Pages/Test.aspx" -Count 1000</dev:code> <maml:remarks> <maml:para>Calculates statistics on response time of Test.aspx by sending 1000 requests with default sleep time between requests</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Measure-PnPResponseTime $web -Count 1000 -WarmUp 10 -Histogram 20 -Timeout 50 | Select -expa Histogram | % {$_.GetEnumerator() | Export-Csv C:\Temp\responsetime.csv -NoTypeInformation}</dev:code> <maml:remarks> <maml:para>Builds histogram of response time for the home page of the web and exports to CSV for later processing in Excel</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-PnPClientSideComponent</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Moves a Client-Side Component to a different section/column</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>PnPClientSideComponent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Moves a Client-Side Component to a different location on the page. Notice that the sections and or columns need to be present before moving the component.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-PnPClientSideComponent</maml:name> <command:parameter required="true" position="named"> <maml:name>Section</maml:name> <maml:description> <maml:para>The section to move the web part to</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>The instance id of the control. Use Get-PnPClientSideControl retrieve the instance ids.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Position</maml:name> <maml:description> <maml:para>Change to order of the web part in the column</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-PnPClientSideComponent</maml:name> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para>The column to move the web part to</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>The instance id of the control. Use Get-PnPClientSideControl retrieve the instance ids.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Position</maml:name> <maml:description> <maml:para>Change to order of the web part in the column</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-PnPClientSideComponent</maml:name> <command:parameter required="true" position="named"> <maml:name>Position</maml:name> <maml:description> <maml:para>Change to order of the web part in the column</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>The instance id of the control. Use Get-PnPClientSideControl retrieve the instance ids.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-PnPClientSideComponent</maml:name> <command:parameter required="true" position="named"> <maml:name>Section</maml:name> <maml:description> <maml:para>The section to move the web part to</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para>The column to move the web part to</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>The instance id of the control. Use Get-PnPClientSideControl retrieve the instance ids.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Position</maml:name> <maml:description> <maml:para>Change to order of the web part in the column</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Column</maml:name> <maml:description> <maml:para>The column to move the web part to</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>The instance id of the control. Use Get-PnPClientSideControl retrieve the instance ids.</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> <dev:type> <maml:name>ClientSidePagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Position</maml:name> <maml:description> <maml:para>Change to order of the web part in the column</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Section</maml:name> <maml:description> <maml:para>The section to move the web part to</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Move-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Section 1</dev:code> <maml:remarks> <maml:para>Moves the specified component to the first section of the page.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Move-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Column 2</dev:code> <maml:remarks> <maml:para>Moves the specified component to the second column of the current section.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Move-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Section 1 -Column 2</dev:code> <maml:remarks> <maml:para>Moves the specified component to the first section of the page into the second column.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Move-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Section 1 -Column 2 -Position 2</dev:code> <maml:remarks> <maml:para>Moves the specified component to the first section of the page into the second column and sets the column to position 2 in the list of webparts.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-PnPFile</command:name> <maml:description> <maml:para>Moves a file to a different location</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>PnPFile</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Move-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para>Server relative Url specifying the file to move. Must include the file name.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>TargetUrl</maml:name> <maml:description> <maml:para>Server relative Url where to move the file to. Must include the file name.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteIfAlreadyExists</maml:name> <maml:description> <maml:para>If provided, if a file already exists at the TargetUrl, it will be overwritten. If omitted, the move operation will be canceled if the file already exists at the TargetUrl location.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be requested and the action will be performed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>SiteRelativeUrl</maml:name> <maml:description> <maml:para>Site relative Url specifying the file to move. Must include the file name.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>TargetUrl</maml:name> <maml:description> <maml:para>Server relative Url where to move the file to. Must include the file name.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteIfAlreadyExists</maml:name> <maml:description> <maml:para>If provided, if a file already exists at the TargetUrl, it will be overwritten. If omitted, the move operation will be canceled if the file already exists at the TargetUrl location.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be requested and the action will be performed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be requested and the action will be performed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteIfAlreadyExists</maml:name> <maml:description> <maml:para>If provided, if a file already exists at the TargetUrl, it will be overwritten. If omitted, the move operation will be canceled if the file already exists at the TargetUrl location.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para>Server relative Url specifying the file to move. Must include the file name.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SiteRelativeUrl</maml:name> <maml:description> <maml:para>Site relative Url specifying the file to move. Must include the file name.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>TargetUrl</maml:name> <maml:description> <maml:para>Server relative Url where to move the file to. Must include the file name.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Move-PnPFile -ServerRelativeUrl /sites/project/Documents/company.docx -TargetUrl /sites/otherproject/Documents/company.docx</dev:code> <maml:remarks> <maml:para>Moves a file named company.docx located in the document library called Documents located in the projects sitecollection under the managed path sites to the site collection otherproject located in the managed path sites. If a file named company.aspx already exists, it won't perform the move.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Move-PnPFile -SiteRelativeUrl Documents/company.aspx -TargetUrl /sites/otherproject/Documents/company.docx</dev:code> <maml:remarks> <maml:para>Moves a file named company.docx located in the document library called Documents located in the current site to the Documents library in the site collection otherproject located in the managed path sites. If a file named company.aspx already exists, it won't perform the move.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Move-PnPFile -ServerRelativeUrl /sites/project/Documents/company.docx -TargetUrl /sites/otherproject/Documents/company.docx -OverwriteIfAlreadyExists</dev:code> <maml:remarks> <maml:para>Moves a file named company.docx located in the document library called Documents located in the projects sitecollection under the managed path sites to the site collection otherproject located in the managed path sites. If a file named company.aspx already exists, it will still perform the move and replace the original company.aspx file.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-PnPFolder</command:name> <maml:description> <maml:para>Move a folder to another location in the current web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>PnPFolder</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Move-PnPFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder to move</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>The new parent location to which the folder should be moved to</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder to move</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>The new parent location to which the folder should be moved to</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Folder</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Move-PnPFolder -Folder Documents/Reports -TargetFolder 'Archived Reports'</dev:code> <maml:remarks> <maml:para>This will move the folder Reports in the Documents library to the 'Archived Reports' library</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Move-PnPFolder -Folder 'Shared Documents/Reports/2016/Templates' -TargetFolder 'Shared Documents/Reports'</dev:code> <maml:remarks> <maml:para>This will move the folder Templates to the new location in 'Shared Documents/Reports'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-PnPListItemToRecycleBin</command:name> <maml:description> <maml:para>Moves an item from a list to the Recycle Bin</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>PnPListItemToRecycleBin</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Move-PnPListItemToRecycleBin</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> <dev:type> <maml:name>ListItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Move-PnPListItemToRecycleBin -List "Demo List" -Identity "1" -Force</dev:code> <maml:remarks> <maml:para>Moves the listitem with id "1" from the "Demo List" list to the Recycle Bin.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-PnPRecycleBinItem</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Moves all items or a specific item in the first stage recycle bin of the current site collection to the second stage recycle bin</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>PnPRecycleBinItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Move-PnPRecycleBinItem</maml:name> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If provided, moves the item with the specific ID to the second stage recycle bin</maml:para> </maml:description> <command:parameterValue required="true">RecycleBinItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to move the first stage recycle bin items to the second stage</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to move the first stage recycle bin items to the second stage</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If provided, moves the item with the specific ID to the second stage recycle bin</maml:para> </maml:description> <command:parameterValue required="false">RecycleBinItemPipeBind</command:parameterValue> <dev:type> <maml:name>RecycleBinItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Move-PnpRecycleBinItem</dev:code> <maml:remarks> <maml:para>Moves all the items in the first stage recycle bin of the current site collection to the second stage recycle bin</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Move-PnpRecycleBinItem -Identity 26ffff29-b526-4451-9b6f-7f0e56ba7125</dev:code> <maml:remarks> <maml:para>Moves the item with the provided ID in the first stage recycle bin of the current site collection to the second stage recycle bin without asking for confirmation first</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Move-PnpRecycleBinItem -Force</dev:code> <maml:remarks> <maml:para>Moves all the items in the first stage recycle bin of the current context to the second stage recycle bin without asking for confirmation first</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPExtensibilityHandlerObject</command:name> <maml:description> <maml:para>Creates an ExtensibilityHandler Object, to be used by the Get-PnPProvisioningTemplate cmdlet</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPExtensibilityHandlerObject</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPExtensibilityHandlerObject</maml:name> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the handler</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Assembly</maml:name> <maml:description> <maml:para>The full assembly name of the handler</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Any configuration data you want to send to the handler</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>If set, the handler will be disabled</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Assembly</maml:name> <maml:description> <maml:para>The full assembly name of the handler</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Any configuration data you want to send to the handler</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>If set, the handler will be disabled</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the handler</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OfficeDevPnP.Core.Framework.Provisioning.Model.ExtensibilityHandler</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code> PS:> $handler = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler PS:> Get-PnPProvisioningTemplate -Out NewTemplate.xml -ExtensibilityHandlers $handler</dev:code> <maml:remarks> <maml:para>This will create a new ExtensibilityHandler object that is run during extraction of the template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPGroup</command:name> <maml:description> <maml:para>Adds group to the Site Groups List and returns a group object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The Title of the group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description for the group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>The owner for the group, which can be a user or another group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoAcceptRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether users are automatically added or removed when they make a request</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowMembersEditMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether group members can modify membership in the group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisallowMembersViewMembership</maml:name> <maml:description> <maml:para>A switch parameter that disallows group members to view membership.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestToJoinEmail</maml:name> <maml:description> <maml:para>The e-mail address to which membership requests are sent</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AllowMembersEditMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether group members can modify membership in the group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoAcceptRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether users are automatically added or removed when they make a request</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description for the group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisallowMembersViewMembership</maml:name> <maml:description> <maml:para>A switch parameter that disallows group members to view membership.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>The owner for the group, which can be a user or another group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestToJoinEmail</maml:name> <maml:description> <maml:para>The e-mail address to which membership requests are sent</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The Title of the group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Group</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPGroup -Title "My Site Users"</dev:code> <maml:remarks> <maml:para /> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPList</command:name> <maml:description> <maml:para>Creates a new list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPList</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The Title of the list</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The type of list to create.</maml:para> </maml:description> <command:parameterValue required="true">ListTemplateType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>If set, will override the url of the list.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Hidden</maml:name> <maml:description> <maml:para>Switch parameter if list should be hidden from the SharePoint UI</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableVersioning</maml:name> <maml:description> <maml:para>Switch parameter if versioning should be enabled</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableContentTypes</maml:name> <maml:description> <maml:para>Switch parameter if content types should be enabled on this list</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OnQuickLaunch</maml:name> <maml:description> <maml:para>Switch parameter if this list should be visible on the QuickLaunch</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>EnableContentTypes</maml:name> <maml:description> <maml:para>Switch parameter if content types should be enabled on this list</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableVersioning</maml:name> <maml:description> <maml:para>Switch parameter if versioning should be enabled</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Hidden</maml:name> <maml:description> <maml:para>Switch parameter if list should be hidden from the SharePoint UI</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OnQuickLaunch</maml:name> <maml:description> <maml:para>Switch parameter if this list should be visible on the QuickLaunch</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The type of list to create.</maml:para> </maml:description> <command:parameterValue required="true">ListTemplateType</command:parameterValue> <dev:type> <maml:name>ListTemplateType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The Title of the list</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>If set, will override the url of the list.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPList -Title Announcements -Template Announcements</dev:code> <maml:remarks> <maml:para>Create a new announcements list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPList -Title "Demo List" -Url "lists/DemoList" -Template Announcements</dev:code> <maml:remarks> <maml:para>Create an announcements list with a title that is different from the url</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPList -Title HiddenList -Template GenericList -Hidden</dev:code> <maml:remarks> <maml:para>Create a new custom list and hides it from the SharePoint UI</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPPersonalSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Office365 only: Creates a personal / OneDrive For Business site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPPersonalSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPPersonalSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>The UserPrincipalName (UPN) of the users</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>The UserPrincipalName (UPN) of the users</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $users = ('katiej@contoso.onmicrosoft.com','garth@contoso.onmicrosoft.com') PS:> New-PnPPersonalSite -Email $users</dev:code> <maml:remarks> <maml:para>Creates a personal / OneDrive For Business site for the 2 users in the variable $users</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPAzureCertificate</command:name> <maml:description> <maml:para>Generate a new 2048bit self-signed certificate and manifest settings for use when using CSOM via an app-only ADAL application. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. KeyCredentials contains the ADAL app manifest sections. Certificate contains the PEM encoded certificate. PrivateKey contains the PEM encoded private key of the certificate.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPAzureCertificate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPAzureCertificate</maml:name> <command:parameter required="false" position="named"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>Common Name (e.g. server FQDN or YOUR name) [pnp.contoso.com]</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Country</maml:name> <maml:description> <maml:para>Country Name (2 letter code)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>State</maml:name> <maml:description> <maml:para>State or Province Name (full name)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Locality</maml:name> <maml:description> <maml:para>Locality Name (eg, city)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization Name (eg, company)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="5"> <maml:name>OrganizationUnit</maml:name> <maml:description> <maml:para>Organizational Unit Name (eg, section)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>OutPfx</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path (.pfx)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="6"> <maml:name>OutCert</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path (.cer)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ValidYears</maml:name> <maml:description> <maml:para>Number of years until expiration (default is 10, max is 30)</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="8"> <maml:name>CertificatePassword</maml:name> <maml:description> <maml:para>Optional certificate password</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="8"> <maml:name>CertificatePassword</maml:name> <maml:description> <maml:para>Optional certificate password</maml:para> </maml:description> <command:parameterValue required="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>Common Name (e.g. server FQDN or YOUR name) [pnp.contoso.com]</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Country</maml:name> <maml:description> <maml:para>Country Name (2 letter code)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Locality</maml:name> <maml:description> <maml:para>Locality Name (eg, city)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization Name (eg, company)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>OrganizationUnit</maml:name> <maml:description> <maml:para>Organizational Unit Name (eg, section)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>OutCert</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path (.cer)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>OutPfx</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path (.pfx)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>State</maml:name> <maml:description> <maml:para>State or Province Name (full name)</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ValidYears</maml:name> <maml:description> <maml:para>Number of years until expiration (default is 10, max is 30)</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPAzureCertificate -OutPfx pnp.pfx -OutCert pnp.cer</dev:code> <maml:remarks> <maml:para>This will generate a default self-signed certificate named "pnp.contoso.com" valid for 10 years and output a pfx and cer file.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPAzureCertificate -CommonName "My Certificate" -ValidYears 30 </dev:code> <maml:remarks> <maml:para>This will output a certificate named "My Certificate" which expires in 30 years from now.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPUnifiedGroup</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Creates a new Office 365 Group (aka Unified Group). Requires the Azure Active Directory application permission 'Group.ReadWrite.All'.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPUnifiedGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPUnifiedGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The Display Name of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>MailNickname</maml:name> <maml:description> <maml:para>The Mail Nickname of the Office 365 Group. Cannot contain spaces.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>The array UPN values of the group's owners.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>The array UPN values of the group's members.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsPrivate</maml:name> <maml:description> <maml:para>Makes the group private when selected.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GroupLogoPath</maml:name> <maml:description> <maml:para>The path to the logo file of to set.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateTeam</maml:name> <maml:description> <maml:para>Creates a MS Teams team associated with created group.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>CreateTeam</maml:name> <maml:description> <maml:para>Creates a MS Teams team associated with created group.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The Display Name of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GroupLogoPath</maml:name> <maml:description> <maml:para>The path to the logo file of to set.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsPrivate</maml:name> <maml:description> <maml:para>Makes the group private when selected.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>MailNickname</maml:name> <maml:description> <maml:para>The Mail Nickname of the Office 365 Group. Cannot contain spaces.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>The array UPN values of the group's members.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>The array UPN values of the group's owners.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPUnifiedGroup -DisplayName $displayName -Description $description -MailNickname $nickname</dev:code> <maml:remarks> <maml:para>Creates a public Office 365 Group with all the required properties</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPUnifiedGroup -DisplayName $displayName -Description $description -MailNickname $nickname -Owners $arrayOfOwners -Members $arrayOfMembers</dev:code> <maml:remarks> <maml:para>Creates a public Office 365 Group with all the required properties, and with a custom list of Owners and a custom list of Members</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPUnifiedGroup -DisplayName $displayName -Description $description -MailNickname $nickname -IsPrivate</dev:code> <maml:remarks> <maml:para>Creates a private Office 365 Group with all the required properties</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPUnifiedGroup -DisplayName $displayName -Description $description -MailNickname $nickname -Owners $arrayOfOwners -Members $arrayOfMembers -IsPrivate</dev:code> <maml:remarks> <maml:para>Creates a private Office 365 Group with all the required properties, and with a custom list of Owners and a custom list of Members</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPProvisioningTemplate</command:name> <maml:description> <maml:para>Creates a new provisioning template object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax /> <command:parameters /> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $template = New-PnPProvisioningTemplate</dev:code> <maml:remarks> <maml:para>Creates a new instance of a site template object.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPProvisioningTemplateFromFolder</command:name> <maml:description> <maml:para>Generates a provisioning template from a given folder, including only files that are present in that folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPProvisioningTemplateFromFolder</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPProvisioningTemplateFromFolder</maml:name> <command:parameter required="false" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>Optional wildcard pattern to match filenames against. If empty all files will be included.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>An optional content type to use.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Properties</maml:name> <maml:description> <maml:para>Additional properties to set for every file entry in the generated template.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AsIncludeFile</maml:name> <maml:description> <maml:para>If specified, the output will only contain the <pnp:Files> element. This allows the output to be included in another template.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>The encoding type of the XML file, Unicode is default</maml:para> </maml:description> <command:parameterValue required="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Folder to process. If not specified the current folder will be used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>Target folder to provision to files to. If not specified, the current folder name will be used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Schema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="true">XMLPnPSchemaVersion</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AsIncludeFile</maml:name> <maml:description> <maml:para>If specified, the output will only contain the <pnp:Files> element. This allows the output to be included in another template.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>An optional content type to use.</maml:para> </maml:description> <command:parameterValue required="false">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>The encoding type of the XML file, Unicode is default</maml:para> </maml:description> <command:parameterValue required="false">Encoding</command:parameterValue> <dev:type> <maml:name>Encoding</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Folder to process. If not specified the current folder will be used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Match</maml:name> <maml:description> <maml:para>Optional wildcard pattern to match filenames against. If empty all files will be included.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Properties</maml:name> <maml:description> <maml:para>Additional properties to set for every file entry in the generated template.</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Schema</maml:name> <maml:description> <maml:para>The schema of the output to use, defaults to the latest schema</maml:para> </maml:description> <command:parameterValue required="false">XMLPnPSchemaVersion</command:parameterValue> <dev:type> <maml:name>XMLPnPSchemaVersion</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>Target folder to provision to files to. If not specified, the current folder name will be used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPProvisioningTemplateFromFolder -Out template.xml</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template, and includes all files in the current folder.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template, and includes all files in the c:\temp folder.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js -TargetFolder "Shared Documents"</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder and marks the files in the template to be added to the 'Shared Documents' folder</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js -TargetFolder "Shared Documents" -ContentType "Test Content Type"</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder and marks the files in the template to be added to the 'Shared Documents' folder. It will add a property to the item for the content type.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPProvisioningTemplateFromFolder -Out template.xml -Folder c:\temp -Match *.js -TargetFolder "Shared Documents" -Properties @{"Title" = "Test Title"; "Category"="Test Category"}</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template, and includes all files with a JS extension in the c:\temp folder and marks the files in the template to be added to the 'Shared Documents' folder. It will add the specified properties to the file entries.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPProvisioningTemplateFromFolder -Out template.pnp</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template as a pnp package file, and includes all files in the current folder</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 8---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPProvisioningTemplateFromFolder -Out template.pnp -Folder c:\temp</dev:code> <maml:remarks> <maml:para>Creates an empty provisioning template as a pnp package file, and includes all files in the c:\temp folder</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Encoding:</maml:linkText> <maml:uri>https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Creates either a communication site or an Office 365 group-connected team site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPSite</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-PnPSite cmdlet creates a new site collection for the current tenant. Currently only 'modern' sites like Communication Site and the Modern Office 365 group-connected team sites are supported. If you want to create a classic site, use New-PnPTenantSite.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-PnPSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies with type of site to create.</maml:para> </maml:description> <command:parameterValue required="true">SiteType</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the full url of the new site collection, this parameter only applies to Communications Sites</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HubSiteId</maml:name> <maml:description> <maml:para>If specified the site will be associated to the hubsite as identified by this id</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If specified the cmdlet will wait until the site has been fully created and all site artifacts have been provisioned by SharePoint. Notice that this can take a while.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Classification</maml:name> <maml:description> <maml:para>Specifies the classification of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Specifies the owner of the site. Specify the value as a string array: "user@domain.com"</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowFileSharingForGuestUsers</maml:name> <maml:description> <maml:para>Specifies if guest users can share files in the new site collection</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SiteDesign</maml:name> <maml:description> <maml:para>Specifies the site design of the new site collection. Defaults to 'Topic'</maml:para> </maml:description> <command:parameterValue required="true">CommunicationSiteDesign</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>Specifies the language of the new site collection. Defaults to the current language of the web connected to.</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PnPSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies with type of site to create.</maml:para> </maml:description> <command:parameterValue required="true">SiteType</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Alias</maml:name> <maml:description> <maml:para>Specifies the alias of the new site collection which represents the part of the URL that will be assigned to the site behind 'https://tenant.sharepoint.com/sites/' or 'https://tenant.sharepoint.com/teams/' based on the managed path configuration in the SharePoint Online Admin portal, this parameter only applies to Modern Team Sites</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HubSiteId</maml:name> <maml:description> <maml:para>If specified the site will be associated to the hubsite as identified by this id</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If specified the cmdlet will wait until the site has been fully created and all site artifacts have been provisioned by SharePoint. Notice that this can take a while.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>Specifies the language of the new site collection. Defaults to the current language of the web connected to.</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Classification</maml:name> <maml:description> <maml:para>Specifies the classification of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsPublic</maml:name> <maml:description> <maml:para>Specifies if new site collection is public. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies the owners of the site. Specify the value as a string array: "user@domain.com","anotheruser@domain.com"</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PnPSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies with type of site to create.</maml:para> </maml:description> <command:parameterValue required="true">SiteType</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the full url of the new site collection, this parameter only applies to Communications Sites</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para>Specifies the site design id to use for the new site collection. If specified will override SiteDesign</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HubSiteId</maml:name> <maml:description> <maml:para>If specified the site will be associated to the hubsite as identified by this id</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If specified the cmdlet will wait until the site has been fully created and all site artifacts have been provisioned by SharePoint. Notice that this can take a while.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Classification</maml:name> <maml:description> <maml:para>Specifies the classification of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Specifies the owner of the site. Specify the value as a string array: "user@domain.com"</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowFileSharingForGuestUsers</maml:name> <maml:description> <maml:para>Specifies if guest users can share files in the new site collection</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>Specifies the language of the new site collection. Defaults to the current language of the web connected to.</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Alias</maml:name> <maml:description> <maml:para>Specifies the alias of the new site collection which represents the part of the URL that will be assigned to the site behind 'https://tenant.sharepoint.com/sites/' or 'https://tenant.sharepoint.com/teams/' based on the managed path configuration in the SharePoint Online Admin portal, this parameter only applies to Modern Team Sites</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowFileSharingForGuestUsers</maml:name> <maml:description> <maml:para>Specifies if guest users can share files in the new site collection</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Classification</maml:name> <maml:description> <maml:para>Specifies the classification of the new site collection</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the new site collection</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HubSiteId</maml:name> <maml:description> <maml:para>If specified the site will be associated to the hubsite as identified by this id</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsPublic</maml:name> <maml:description> <maml:para>Specifies if new site collection is public. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>Specifies the language of the new site collection. Defaults to the current language of the web connected to.</maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Specifies the owner of the site. Specify the value as a string array: "user@domain.com"</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies the owners of the site. Specify the value as a string array: "user@domain.com","anotheruser@domain.com"</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SiteDesign</maml:name> <maml:description> <maml:para>Specifies the site design of the new site collection. Defaults to 'Topic'</maml:para> </maml:description> <command:parameterValue required="false">CommunicationSiteDesign</command:parameterValue> <dev:type> <maml:name>CommunicationSiteDesign</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para>Specifies the site design id to use for the new site collection. If specified will override SiteDesign</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies with type of site to create.</maml:para> </maml:description> <command:parameterValue required="true">SiteType</command:parameterValue> <dev:type> <maml:name>SiteType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the full url of the new site collection, this parameter only applies to Communications Sites</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If specified the cmdlet will wait until the site has been fully created and all site artifacts have been provisioned by SharePoint. Notice that this can take a while.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>Returns the url of the newly created site collection</maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso</dev:code> <maml:remarks> <maml:para>This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -SiteDesign Showcase</dev:code> <maml:remarks> <maml:para>This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'. It will use the 'Showcase' design for the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -SiteDesignId ae2349d5-97d6-4440-94d1-6516b72449ac</dev:code> <maml:remarks> <maml:para>This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'. It will use the specified custom site design for the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Classification "HBI"</dev:code> <maml:remarks> <maml:para>This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'. The classification for the site will be set to "HBI"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -ShareByEmailEnabled</dev:code> <maml:remarks> <maml:para>This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso'. Allows owners to invite users outside of the organization.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPSite -Type CommunicationSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Lcid 1040</dev:code> <maml:remarks> <maml:para>This will create a new Communications Site collection with the title 'Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso' and sets the default language to Italian.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPSite -Type TeamSite -Title 'Team Contoso' -Alias contoso</dev:code> <maml:remarks> <maml:para>This will create a new Modern Team Site collection with the title 'Team Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso' or 'https://tenant.sharepoint.com/teams/contoso' based on the managed path configuration in the SharePoint Online Admin portal.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 8---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPSite -Type TeamSite -Title 'Team Contoso' -Alias contoso -IsPublic</dev:code> <maml:remarks> <maml:para>This will create a new Modern Team Site collection with the title 'Team Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso' or 'https://tenant.sharepoint.com/teams/contoso' based on the managed path configuration in the SharePoint Online Admin portal and sets the site to public.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 9---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPSite -Type TeamSite -Title 'Team Contoso' -Alias contoso -Lcid 1040</dev:code> <maml:remarks> <maml:para>This will create a new Modern Team Site collection with the title 'Team Contoso' and the url 'https://tenant.sharepoint.com/sites/contoso' or 'https://tenant.sharepoint.com/teams/contoso' based on the managed path configuration in the SharePoint Online Admin portal and sets the default language of the site to Italian.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPTenantSequence</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Creates a new tenant sequence object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPTenantSequence</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPTenantSequence</maml:name> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Optional Id of the sequence</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Optional Id of the sequence</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $sequence = New-PnPTenantSequence</dev:code> <maml:remarks> <maml:para>Creates a new instance of a tenant sequence object.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $sequence = New-PnPTenantSequence -Id "MySequence"</dev:code> <maml:remarks> <maml:para>Creates a new instance of a tenant sequence object and sets the Id to the value specified.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPTenantSequenceCommunicationSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Creates a communication site object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPTenantSequenceCommunicationSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPTenantSequenceCommunicationSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Classification</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HubSite</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowFileSharingForGuestUsers</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateIds</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AllowFileSharingForGuestUsers</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Classification</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HubSite</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateIds</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $site = New-PnPTenantSequenceCommunicationSite -Url "/sites/mycommunicationsite" -Title "My Team Site"</dev:code> <maml:remarks> <maml:para>Creates a new communication site object with the specified variables</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPTenantSequenceTeamNoGroupSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Creates a new team site without an Office 365 group in-memory object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPTenantSequenceTeamNoGroupSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPTenantSequenceTeamNoGroupSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TimeZoneId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HubSite</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateIds</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HubSite</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateIds</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TimeZoneId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $site = New-PnPTenantSequenceTeamNoGroupSite -Url "/sites/MyTeamSite" -Title "My Team Site"</dev:code> <maml:remarks> <maml:para>Creates a new team site object with the specified variables</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPTenantSequenceTeamNoGroupSubSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Creates a team site subsite with no Office 365 group object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPTenantSequenceTeamNoGroupSubSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPTenantSequenceTeamNoGroupSubSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TimeZoneId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateIds</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>QuickLaunchDisabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseDifferentPermissionsFromParentSite</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>QuickLaunchDisabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateIds</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TimeZoneId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseDifferentPermissionsFromParentSite</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $site = New-PnPTenantSequenceTeamNoGroupSubSite -Url "MyTeamSubsite" -Title "My Team Site" -TimeZoneId 4</dev:code> <maml:remarks> <maml:para>Creates a new team site subsite object with the specified variables</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPTenantSequenceTeamSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Creates a team site object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPTenantSequenceTeamSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPTenantSequenceTeamSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Alias</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Classification</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Public</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HubSite</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateIds</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Alias</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Classification</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HubSite</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Public</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateIds</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $site = New-PnPTenantSequenceTeamSite -Alias "MyTeamSite" -Title "My Team Site"</dev:code> <maml:remarks> <maml:para>Creates a new team site object with the specified variables</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPTenantSite</command:name> <maml:description> <maml:para>Creates a new (classic) site collection for the current tenant</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPTenantSite</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-PnPTenantSite cmdlet creates a new site collection for the current company. However, creating a new SharePoint Online site collection fails if a deleted site with the same URL exists in the Recycle Bin. If you want to use this command for an on-premises farm, please refer to http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-PnPTenantSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the full URL of the new site collection. It must be in a valid managed path in the company's site. For example, for company contoso, valid managed paths are https://contoso.sharepoint.com/sites and https://contoso.sharepoint.com/teams.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Specifies the user name of the site collection's primary owner. The owner must be a user instead of a security group or an email-enabled security group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>Use Get-PnPTimeZoneId to retrieve possible timezone values</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.splanguage.lcid.aspx. To get the list of supported languages use: (Get-PnPWeb -Includes RegionalSettings.InstalledLanguages).RegionalSettings.InstalledLanguages </maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specifies the site collection template type. Use the Get-PnPWebTemplates cmdlet to get the list of valid templates. If no template is specified, one can be added later. The Template and LocaleId parameters must be a valid combination as returned from the Get-PnPWebTemplates cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceQuota</maml:name> <maml:description> <maml:para>Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010 : http://msdn.microsoft.com/en-us/library/gg615462.aspx.</maml:para> </maml:description> <command:parameterValue required="true">Double</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceQuotaWarningLevel</maml:name> <maml:description> <maml:para>Specifies the warning level for the resource quota. This value must not exceed the value set for the ResourceQuota parameter</maml:para> </maml:description> <command:parameterValue required="true">Double</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageQuota</maml:name> <maml:description> <maml:para>Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageQuotaWarningLevel</maml:name> <maml:description> <maml:para>Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageQuota parameter</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveDeletedSite</maml:name> <maml:description> <maml:para>Specifies if any existing site with the same URL should be removed from the recycle bin</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.splanguage.lcid.aspx. To get the list of supported languages use: (Get-PnPWeb -Includes RegionalSettings.InstalledLanguages).RegionalSettings.InstalledLanguages </maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Specifies the user name of the site collection's primary owner. The owner must be a user instead of a security group or an email-enabled security group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveDeletedSite</maml:name> <maml:description> <maml:para>Specifies if any existing site with the same URL should be removed from the recycle bin</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceQuota</maml:name> <maml:description> <maml:para>Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010 : http://msdn.microsoft.com/en-us/library/gg615462.aspx.</maml:para> </maml:description> <command:parameterValue required="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResourceQuotaWarningLevel</maml:name> <maml:description> <maml:para>Specifies the warning level for the resource quota. This value must not exceed the value set for the ResourceQuota parameter</maml:para> </maml:description> <command:parameterValue required="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageQuota</maml:name> <maml:description> <maml:para>Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageQuotaWarningLevel</maml:name> <maml:description> <maml:para>Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageQuota parameter</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specifies the site collection template type. Use the Get-PnPWebTemplates cmdlet to get the list of valid templates. If no template is specified, one can be added later. The Template and LocaleId parameters must be a valid combination as returned from the Get-PnPWebTemplates cmdlet.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>Use Get-PnPTimeZoneId to retrieve possible timezone values</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the new site collection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the full URL of the new site collection. It must be in a valid managed path in the company's site. For example, for company contoso, valid managed paths are https://contoso.sharepoint.com/sites and https://contoso.sharepoint.com/teams.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPTenantSite -Title Contoso -Url https://tenant.sharepoint.com/sites/contoso -Owner user@example.org -TimeZone 4 -Template STS#0</dev:code> <maml:remarks> <maml:para>This will add a site collection with the title 'Contoso', the url 'https://tenant.sharepoint.com/sites/contoso', the timezone 'UTC+01:00',the owner 'user@example.org' and the template used will be STS#0, a TeamSite</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPTenantSite -Title Contoso -Url /sites/contososite -Owner user@example.org -TimeZone 4 -Template STS#0</dev:code> <maml:remarks> <maml:para>This will add a site collection with the title 'Contoso', the url 'https://tenant.sharepoint.com/sites/contososite' of which the base part will be picked up from your current connection, the timezone 'UTC+01:00', the owner 'user@example.org' and the template used will be STS#0, a TeamSite</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Locale IDs:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resource Usage Limits on Sandboxed Solutions in SharePoint 2010:</maml:linkText> <maml:uri>http://msdn.microsoft.com/en-us/library/gg615462.aspx.</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Creating on-premises site collections using CSOM:</maml:linkText> <maml:uri>http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPTenantTemplate</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Creates a new tenant template object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPTenantTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPTenantTemplate</maml:name> <command:parameter required="false" position="named"> <maml:name>Author</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Generator</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Author</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Generator</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $template = New-PnPTenantTemplate</dev:code> <maml:remarks> <maml:para>Creates a new instance of a tenant template object.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPTerm</command:name> <maml:description> <maml:para>Creates a taxonomy term</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPTerm</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPTerm</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the term.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermGroup</maml:name> <maml:description> <maml:para>The termgroup to create the term in.</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TermGroup</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermSet</maml:name> <maml:description> <maml:para>The termset to add the term to.</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TaxonomyItem</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id to use for the term; if not specified, or the empty GUID, a random GUID is generated and used.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>The locale id to use for the term. Defaults to the current locale id.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Descriptive text to help users understand the intended use of this term.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomProperties</maml:name> <maml:description> <maml:para>Custom Properties</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LocalCustomProperties</maml:name> <maml:description> <maml:para>Custom Properties</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStore</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">Id, Name or Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>CustomProperties</maml:name> <maml:description> <maml:para>Custom Properties</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Descriptive text to help users understand the intended use of this term.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id to use for the term; if not specified, or the empty GUID, a random GUID is generated and used.</maml:para> </maml:description> <command:parameterValue required="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>The locale id to use for the term. Defaults to the current locale id.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LocalCustomProperties</maml:name> <maml:description> <maml:para>Custom Properties</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the term.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermGroup</maml:name> <maml:description> <maml:para>The termgroup to create the term in.</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TermGroup</command:parameterValue> <dev:type> <maml:name>Id, Title or TermGroup</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermSet</maml:name> <maml:description> <maml:para>The termset to add the term to.</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TaxonomyItem</command:parameterValue> <dev:type> <maml:name>Id, Title or TaxonomyItem</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStore</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="false">Id, Name or Object</command:parameterValue> <dev:type> <maml:name>Id, Name or Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Taxonomy.Term</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPTerm -TermSet "Departments" -TermGroup "Corporate" -Name "Finance"</dev:code> <maml:remarks> <maml:para>Creates a new taxonomy term named "Finance" in the termset Departments which is located in the "Corporate" termgroup</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPTermGroup</command:name> <maml:description> <maml:para>Creates a taxonomy term group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPTermGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPTermGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the taxonomy term group to create.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>GUID to use for the term group; if not specified, or the empty GUID, a random GUID is generated and used.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description to use for the term group.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStore</maml:name> <maml:description> <maml:para>Term store to add the group to; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">Id, Name or Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description to use for the term group.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>GUID to use for the term group; if not specified, or the empty GUID, a random GUID is generated and used.</maml:para> </maml:description> <command:parameterValue required="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the taxonomy term group to create.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStore</maml:name> <maml:description> <maml:para>Term store to add the group to; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="false">Id, Name or Object</command:parameterValue> <dev:type> <maml:name>Id, Name or Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Taxonomy.TermGroup</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPTermGroup -GroupName "Countries"</dev:code> <maml:remarks> <maml:para>Creates a new taxonomy term group named "Countries"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPTermLabel</command:name> <maml:description> <maml:para>Creates a localized label for a taxonomy term</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPTermLabel</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates a localized label for a taxonomy term. Use Get-PnPTerm -Include Labels to request the current labels on a taxonomy term.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-PnPTermLabel</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The localized name of the term</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>The locale id to use for the localized term</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Term</maml:name> <maml:description> <maml:para>The term to add the localized label to</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TaxonomyItem</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Makes this new label the default label</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Makes this new label the default label</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>The locale id to use for the localized term</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The localized name of the term</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Term</maml:name> <maml:description> <maml:para>The term to add the localized label to</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TaxonomyItem</command:parameterValue> <dev:type> <maml:name>Id, Title or TaxonomyItem</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Taxonomy.Label</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPTermLabel -Name "Finanzwesen" -Lcid 1031 -Term (Get-PnPTerm -Identity "Finance" -TermSet "Departments" -TermGroup "Corporate")</dev:code> <maml:remarks> <maml:para>Creates a new localized taxonomy label in German (LCID 1031) named "Finanzwesen" for the term "Finance" in the termset Departments which is located in the "Corporate" termgroup</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTerm -Identity "Finance" -TermSet "Departments" -TermGroup "Corporate" | New-PnPTermLabel -Name "Finanzwesen" -Lcid 1031</dev:code> <maml:remarks> <maml:para>Creates a new localized taxonomy label in German (LCID 1031) named "Finanzwesen" for the term "Finance" in the termset Departments which is located in the "Corporate" termgroup</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPTermSet</command:name> <maml:description> <maml:para>Creates a taxonomy term set</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPTermSet</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPTermSet</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the termset.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermGroup</maml:name> <maml:description> <maml:para>Name, id or actually termgroup to create the termset in.</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TermGroup</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id to use for the term set; if not specified, or the empty GUID, a random GUID is generated and used.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>The locale id to use for the term set. Defaults to the current locale id.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Contact</maml:name> <maml:description> <maml:para>An e-mail address for term suggestion and feedback. If left blank the suggestion feature will be disabled.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Descriptive text to help users understand the intended use of this term set.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsOpenForTermCreation</maml:name> <maml:description> <maml:para>When a term set is closed, only metadata managers can add terms to this term set. When it is open, users can add terms from a tagging application. Not specifying this switch will make the term set closed.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsNotAvailableForTagging</maml:name> <maml:description> <maml:para>By default a term set is available to be used by end users and content editors of sites consuming this term set. Specify this switch to turn this off</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>The primary user or group of this term set.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StakeHolders</maml:name> <maml:description> <maml:para>People and groups in the organization that should be notified before major changes are made to the term set. You can enter multiple users or groups.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomProperties</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStore</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">Id, Name or Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Contact</maml:name> <maml:description> <maml:para>An e-mail address for term suggestion and feedback. If left blank the suggestion feature will be disabled.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomProperties</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Descriptive text to help users understand the intended use of this term set.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id to use for the term set; if not specified, or the empty GUID, a random GUID is generated and used.</maml:para> </maml:description> <command:parameterValue required="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsNotAvailableForTagging</maml:name> <maml:description> <maml:para>By default a term set is available to be used by end users and content editors of sites consuming this term set. Specify this switch to turn this off</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsOpenForTermCreation</maml:name> <maml:description> <maml:para>When a term set is closed, only metadata managers can add terms to this term set. When it is open, users can add terms from a tagging application. Not specifying this switch will make the term set closed.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Lcid</maml:name> <maml:description> <maml:para>The locale id to use for the term set. Defaults to the current locale id.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the termset.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>The primary user or group of this term set.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StakeHolders</maml:name> <maml:description> <maml:para>People and groups in the organization that should be notified before major changes are made to the term set. You can enter multiple users or groups.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermGroup</maml:name> <maml:description> <maml:para>Name, id or actually termgroup to create the termset in.</maml:para> </maml:description> <command:parameterValue required="true">Id, Title or TermGroup</command:parameterValue> <dev:type> <maml:name>Id, Title or TermGroup</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStore</maml:name> <maml:description> <maml:para>Term store to check; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="false">Id, Name or Object</command:parameterValue> <dev:type> <maml:name>Id, Name or Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Taxonomy.TermSet</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPTermSet -Name "Department" -TermGroup "Corporate"</dev:code> <maml:remarks> <maml:para>Creates a new termset named "Department" in the group named "Corporate"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPUPABulkImportJob</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Submit up a new user profile bulk import job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPUPABulkImportJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/bulk-user-profile-update-api-for-sharepoint-online for information on the API and how the bulk import process works.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-PnPUPABulkImportJob</maml:name> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site or server relative URL of the folder to where you want to store the import job file.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The local file path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="2"> <maml:name>UserProfilePropertyMapping</maml:name> <maml:description> <maml:para>Specify user profile property mapping between the import file and UPA property names.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="true" position="3"> <maml:name>IdProperty</maml:name> <maml:description> <maml:para>The name of the identifying property in your file.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="4"> <maml:name>IdType</maml:name> <maml:description> <maml:para>The type of profile identifier (Email/CloudId/PrincipalName). Defaults to Email.</maml:para> </maml:description> <command:parameterValue required="true">ImportProfilePropertiesUserIdType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site or server relative URL of the folder to where you want to store the import job file.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>IdProperty</maml:name> <maml:description> <maml:para>The name of the identifying property in your file.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>IdType</maml:name> <maml:description> <maml:para>The type of profile identifier (Email/CloudId/PrincipalName). Defaults to Email.</maml:para> </maml:description> <command:parameterValue required="false">ImportProfilePropertiesUserIdType</command:parameterValue> <dev:type> <maml:name>ImportProfilePropertiesUserIdType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The local file path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>UserProfilePropertyMapping</maml:name> <maml:description> <maml:para>Specify user profile property mapping between the import file and UPA property names.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> @" { "value": [ { "IdName": "mikaels@contoso.com", "Department": "PnP", }, { "IdName": "vesaj@contoso.com", "Department": "PnP", } ] } "@ > profiles.json PS:> New-PnPUPABulkImportJob -Folder "Shared Documents" -Path profiles.json -IdProperty "IdName" -UserProfilePropertyMapping @{"Department"="Department"}</dev:code> <maml:remarks> <maml:para>This will submit a new user profile bulk import job to SharePoint Online.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPUser</command:name> <maml:description> <maml:para>Adds a user to the built-in Site User Info List and returns a user object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPUser</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPUser</maml:name> <command:parameter required="true" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>The users login name (user@company.com)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>The users login name (user@company.com)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.User</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPUser -LoginName user@company.com</dev:code> <maml:remarks> <maml:para>Adds a new user with the login user@company.com to the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PnPWeb</command:name> <maml:description> <maml:para>Creates a new subweb under the current web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>PnPWeb</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-PnPWeb</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the new web</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The URL of the new web</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The site definition template to use for the new web, e.g. STS#0. Use Get-PnPWebTemplates to fetch a list of available templates</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the new web</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Locale</maml:name> <maml:description> <maml:para>The language id of the new web. default = 1033 for English</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BreakInheritance</maml:name> <maml:description> <maml:para>By default the subweb will inherit its security from its parent, specify this switch to break this inheritance</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InheritNavigation</maml:name> <maml:description> <maml:para>Specifies whether the site inherits navigation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>BreakInheritance</maml:name> <maml:description> <maml:para>By default the subweb will inherit its security from its parent, specify this switch to break this inheritance</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the new web</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InheritNavigation</maml:name> <maml:description> <maml:para>Specifies whether the site inherits navigation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Locale</maml:name> <maml:description> <maml:para>The language id of the new web. default = 1033 for English</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The site definition template to use for the new web, e.g. STS#0. Use Get-PnPWebTemplates to fetch a list of available templates</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the new web</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The URL of the new web</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Web</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> New-PnPWeb -Title "Project A Web" -Url projectA -Description "Information about Project A" -Locale 1033 -Template "STS#0"</dev:code> <maml:remarks> <maml:para>Creates a new subweb under the current web with URL projectA</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Publish-PnPApp</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Publishes/Deploys/Trusts an available app in the app catalog</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Publish</command:verb> <command:noun>PnPApp</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Publish-PnPApp</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the app</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipFeatureDeployment</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="true">AppCatalogScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the app</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> <dev:type> <maml:name>AppMetadataPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="false">AppCatalogScope</command:parameterValue> <dev:type> <maml:name>AppCatalogScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipFeatureDeployment</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Publish-PnPApp -Identity 2646ccc3-6a2b-46ef-9273-81411cbbb60f</dev:code> <maml:remarks> <maml:para>This will deploy/trust an app into the app catalog. Notice that the app needs to be available in the tenant scoped app catalog</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Publish-PnPApp -Identity 2646ccc3-6a2b-46ef-9273-81411cbbb60f -Scope Site</dev:code> <maml:remarks> <maml:para>This will deploy/trust an app into the app catalog. Notice that the app needs to be available in the site collection scoped app catalog</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Read-PnPProvisioningTemplate</command:name> <maml:description> <maml:para>Loads/Reads a PnP file from the file system or a string</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Read</command:verb> <command:noun>PnPProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Read-PnPProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filename to read from, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while loading the template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Read-PnPProvisioningTemplate</maml:name> <command:parameter required="true" position="1"> <maml:name>Xml</maml:name> <maml:description> <maml:para>Variable to read from, containing the valid XML of a provisioning template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while loading the template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filename to read from, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while loading the template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Xml</maml:name> <maml:description> <maml:para>Variable to read from, containing the valid XML of a provisioning template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Read-PnPProvisioningTemplate -Path template.pnp</dev:code> <maml:remarks> <maml:para>Loads a PnP file from the file system</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Read-PnPProvisioningTemplate -Path template.pnp -TemplateProviderExtensions $extensions</dev:code> <maml:remarks> <maml:para>Loads a PnP file from the file system using some custom template provider extensions while loading the file.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Read-PnPProvisioningTemplate -Xml $xml</dev:code> <maml:remarks> <maml:para>Reads a PnP Provisioning template from a string containing the XML of a provisioning template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Read-PnPTenantTemplate</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Loads/Reads a PnP tenant template from the file system and returns an in-memory instance of this template.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Read</command:verb> <command:noun>PnPTenantTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Read-PnPTenantTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filename to read from, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while loading the template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filename to read from, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while loading the template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Read-PnPTenantTemplate -Path template.pnp</dev:code> <maml:remarks> <maml:para>Reads a PnP tenant template file from the file system and returns an in-memory instance</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Register-PnPHubSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Registers a site as a hubsite</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Register</command:verb> <command:noun>PnPHubSite</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Registers a site as a hubsite</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-PnPHubSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to register as a hubsite</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to register as a hubsite</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> <dev:type> <maml:name>SitePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Register-PnPHubSite -Site https://tenant.sharepoint.com/sites/myhubsite</dev:code> <maml:remarks> <maml:para>This example registers the specified site as a hubsite</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPAlert</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Removes an alert for a user</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPAlert</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPAlert</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The alert id, or the actual alert object to remove.</maml:para> </maml:description> <command:parameterValue required="true">AlertPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User to remove the alert for (User ID, login name or actual User object). Skip this parameter to use the current user. Note: Only site owners can remove alerts for other users.</maml:para> </maml:description> <command:parameterValue required="true">UserPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The alert id, or the actual alert object to remove.</maml:para> </maml:description> <command:parameterValue required="true">AlertPipeBind</command:parameterValue> <dev:type> <maml:name>AlertPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User to remove the alert for (User ID, login name or actual User object). Skip this parameter to use the current user. Note: Only site owners can remove alerts for other users.</maml:para> </maml:description> <command:parameterValue required="false">UserPipeBind</command:parameterValue> <dev:type> <maml:name>UserPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPAlert -Identity 641ac67f-0ce0-4837-874a-743c8f8572a7</dev:code> <maml:remarks> <maml:para>Removes the alert with the specified ID for the current user</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPAlert -Identity 641ac67f-0ce0-4837-874a-743c8f8572a7 -User "i:0#.f|membership|Alice@contoso.onmicrosoft.com"</dev:code> <maml:remarks> <maml:para>Removes the alert with the specified ID for the user specified</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPApp</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Removes an app from the app catalog</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPApp</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPApp</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the Addin Instance</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="true">AppCatalogScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the Addin Instance</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> <dev:type> <maml:name>AppMetadataPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="false">AppCatalogScope</command:parameterValue> <dev:type> <maml:name>AppCatalogScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>This will remove the specified app from the tenant scoped app catalog</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site</dev:code> <maml:remarks> <maml:para>This will remove the specified app from the site collection scoped app catalog</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPApplicationCustomizer</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Removes a SharePoint Framework client side extension application customizer</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPApplicationCustomizer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes a SharePoint Framework client side extension application customizer by removing a user custom action from a web or sitecollection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPApplicationCustomizer</maml:name> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the CustomAction representing the client side extension registration is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection (default).</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use the -Force flag to bypass the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id or name of the CustomAction representing the client side extension registration that needs to be removed or a CustomAction instance itself</maml:para> </maml:description> <command:parameterValue required="true">UserCustomActionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-PnPApplicationCustomizer</maml:name> <command:parameter required="true" position="named"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest for which existing custom action(s) should be removed</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the CustomAction representing the client side extension registration is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection (default).</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use the -Force flag to bypass the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest for which existing custom action(s) should be removed</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use the -Force flag to bypass the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id or name of the CustomAction representing the client side extension registration that needs to be removed or a CustomAction instance itself</maml:para> </maml:description> <command:parameterValue required="false">UserCustomActionPipeBind</command:parameterValue> <dev:type> <maml:name>UserCustomActionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the CustomAction representing the client side extension registration is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection (default).</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2</dev:code> <maml:remarks> <maml:para>Removes the custom action representing the client side extension registration with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPCustomAction -ClientSideComponentId aa66f67e-46c0-4474-8a82-42bf467d07f2 -Scope web</dev:code> <maml:remarks> <maml:para>Removes the custom action(s) being registered for a SharePoint Framework solution having the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' in its manifest from the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPClientSideComponent</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Removes a Client-Side component from a page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPClientSideComponent</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPClientSideComponent</maml:name> <command:parameter required="true" position="named"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>The instance id of the component</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified you will not receive the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified you will not receive the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>The instance id of the component</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> <dev:type> <maml:name>ClientSidePagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPClientSideComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82</dev:code> <maml:remarks> <maml:para>Removes the control specified from the page.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPClientSidePage</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Removes a Client-Side Page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPClientSidePage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPClientSidePage</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> <dev:type> <maml:name>ClientSidePagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPClientSidePage -Identity "MyPage"</dev:code> <maml:remarks> <maml:para>Removes the Client-Side page named 'MyPage.aspx'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPClientSidePage -Identity "Templates/MyPageTemplate"</dev:code> <maml:remarks> <maml:para>Removes the specified Client-Side page which is located in the Templates folder of the Site Pages library.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPClientSidePage $page</dev:code> <maml:remarks> <maml:para>Removes the specified Client-Side page which is contained in the $page variable.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPContentType</command:name> <maml:description> <maml:para>Removes a content type from a web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPContentType</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPContentType</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name or ID of the content type to remove</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name or ID of the content type to remove</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPContentType -Identity "Project Document"</dev:code> <maml:remarks> <maml:para>This will remove a content type called "Project Document" from the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPContentType -Identity "Project Document" -Force</dev:code> <maml:remarks> <maml:para>This will remove a content type called "Project Document" from the current web with force</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPContentTypeFromDocumentSet</command:name> <maml:description> <maml:para>Removes a content type from a document set</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPContentTypeFromDocumentSet</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPContentTypeFromDocumentSet</maml:name> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type to remove. Either specify name, an id, or a content type object.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DocumentSet</maml:name> <maml:description> <maml:para>The document set to remove the content type from. Either specify a name, a document set template object, an id, or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type to remove. Either specify name, an id, or a content type object.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DocumentSet</maml:name> <maml:description> <maml:para>The document set to remove the content type from. Either specify a name, a document set template object, an id, or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> <dev:type> <maml:name>DocumentSetPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPContentTypeFromDocumentSet -ContentType "Test CT" -DocumentSet "Test Document Set"</dev:code> <maml:remarks> <maml:para>This will remove the content type called 'Test CT' from the document set called ''Test Document Set'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPContentTypeFromDocumentSet -ContentType 0x0101001F1CEFF1D4126E4CAD10F00B6137E969 -DocumentSet 0x0120D520005DB65D094035A241BAC9AF083F825F3B</dev:code> <maml:remarks> <maml:para>This will remove the content type with ID '0x0101001F1CEFF1D4126E4CAD10F00B6137E969' from the document set with ID '0x0120D520005DB65D094035A241BAC9AF083F825F3B'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPContentTypeFromList</command:name> <maml:description> <maml:para>Removes a content type from a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPContentTypeFromList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPContentTypeFromList</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The name of the list, its ID or an actual list object from where the content type needs to be removed from</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The name of a content type, its ID or an actual content type object that needs to be removed from the specified list.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The name of a content type, its ID or an actual content type object that needs to be removed from the specified list.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The name of the list, its ID or an actual list object from where the content type needs to be removed from</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPContentTypeFromList -List "Documents" -ContentType "Project Document"</dev:code> <maml:remarks> <maml:para>This will remove a content type called "Project Document" from the "Documents" list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPCustomAction</command:name> <maml:description> <maml:para>Removes a custom action</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPCustomAction</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPCustomAction</maml:name> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the CustomAction is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use the -Force flag to bypass the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id or name of the CustomAction that needs to be removed or a CustomAction instance itself</maml:para> </maml:description> <command:parameterValue required="true">UserCustomActionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use the -Force flag to bypass the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id or name of the CustomAction that needs to be removed or a CustomAction instance itself</maml:para> </maml:description> <command:parameterValue required="false">UserCustomActionPipeBind</command:parameterValue> <dev:type> <maml:name>UserCustomActionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the CustomAction is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection.</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2</dev:code> <maml:remarks> <maml:para>Removes the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 -Scope web</dev:code> <maml:remarks> <maml:para>Removes the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' from the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 -Force</dev:code> <maml:remarks> <maml:para>Removes the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' without asking for confirmation.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPCustomAction -Scope All | ? Location -eq ScriptLink | Remove-PnPCustomAction</dev:code> <maml:remarks> <maml:para>Removes all custom actions that are ScriptLinks</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPDeletedUnifiedGroup</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Permanently removes one deleted Office 365 Group (aka Unified Group)</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPDeletedUnifiedGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPDeletedUnifiedGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the deleted Office 365 Group</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the deleted Office 365 Group</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> <dev:type> <maml:name>UnifiedGroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPDeletedUnifiedGroup -Identity 38b32e13-e900-4d95-b860-fb52bc07ca7f</dev:code> <maml:remarks> <maml:para>Permanently removes a deleted Office 365 Group based on its ID</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $group = Get-PnPDeletedUnifiedGroup -Identity 38b32e13-e900-4d95-b860-fb52bc07ca7f PS:> Remove-PnPDeletedUnifiedGroup -Identity $group</dev:code> <maml:remarks> <maml:para>Permanently removes the provided deleted Office 365 Group</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPIndexedProperty</command:name> <maml:description> <maml:para>Removes a key from propertybag to be indexed by search. The key and it's value remain in the propertybag, however it will not be indexed anymore.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPIndexedProperty</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPIndexedProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key of the property bag value to be removed from indexing</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name from where to remove the indexed properties</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key of the property bag value to be removed from indexing</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name from where to remove the indexed properties</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPIndexedProperty -key "MyIndexProperty"</dev:code> <maml:remarks> <maml:para>Removes the Indexed property "MyIndexProperty" from the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPEventReceiver</command:name> <maml:description> <maml:para>Remove an eventreceiver</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPEventReceiver</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes/unregisters a specific eventreceiver</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPEventReceiver</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Guid of the event receiver on the list</maml:para> </maml:description> <command:parameterValue required="true">EventReceiverPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object from where to remove the event receiver object</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Guid of the event receiver on the list</maml:para> </maml:description> <command:parameterValue required="true">EventReceiverPipeBind</command:parameterValue> <dev:type> <maml:name>EventReceiverPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object from where to remove the event receiver object</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPEventReceiver -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22</dev:code> <maml:remarks> <maml:para>This will remove the event receiver with ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22" from the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPEventReceiver -List ProjectList -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22</dev:code> <maml:remarks> <maml:para>This will remove the event receiver with ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22" from the "ProjectList" list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPEventReceiver -List ProjectList -Identity MyReceiver</dev:code> <maml:remarks> <maml:para>This will remove the event receiver with ReceiverName "MyReceiver" from the "ProjectList" list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPEventReceiver -List ProjectList</dev:code> <maml:remarks> <maml:para>This will remove all event receivers from the "ProjectList" list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPEventReceiver</dev:code> <maml:remarks> <maml:para>This will remove all event receivers from the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPEventReceiver | ? ReceiverUrl -Like "*azurewebsites.net*" | Remove-PnPEventReceiver</dev:code> <maml:remarks> <maml:para>This will remove all event receivers from the current site which are pointing to a service hosted on Azure Websites</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPField</command:name> <maml:description> <maml:para>Removes a field from a list or a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPField</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPField</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The field object or name to remove</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where to remove the field from</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The field object or name to remove</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where to remove the field from</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPField -Identity "Speakers"</dev:code> <maml:remarks> <maml:para>Removes the speakers field from the site columns</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPField -List "Demo list" -Identity "Speakers"</dev:code> <maml:remarks> <maml:para>Removes the speakers field from the list Demo list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPFieldFromContentType</command:name> <maml:description> <maml:para>Removes a site column from a content type</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPFieldFromContentType</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPFieldFromContentType</maml:name> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The field to remove</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type where the field is to be removed from</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DoNotUpdateChildren</maml:name> <maml:description> <maml:para>If specified, inherited content types will not be updated</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type where the field is to be removed from</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DoNotUpdateChildren</maml:name> <maml:description> <maml:para>If specified, inherited content types will not be updated</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The field to remove</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPFieldFromContentType -Field "Project_Name" -ContentType "Project Document"</dev:code> <maml:remarks> <maml:para>This will remove the site column with an internal name of "Project_Name" from a content type called "Project Document"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPFieldFromContentType -Field "Project_Name" -ContentType "Project Document" -DoNotUpdateChildren</dev:code> <maml:remarks> <maml:para>This will remove the site column with an internal name of "Project_Name" from a content type called "Project Document". It will not update content types that inherit from the "Project Document" content type.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPFile</command:name> <maml:description> <maml:para>Removes a file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPFile</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para>Server relative URL to the file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recycle</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>SiteRelativeUrl</maml:name> <maml:description> <maml:para>Site relative URL to the file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recycle</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recycle</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para>Server relative URL to the file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SiteRelativeUrl</maml:name> <maml:description> <maml:para>Site relative URL to the file</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Remove-PnPFile -ServerRelativeUrl /sites/project/_catalogs/themes/15/company.spcolor</dev:code> <maml:remarks> <maml:para>Removes the file company.spcolor</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Remove-PnPFile -SiteRelativeUrl _catalogs/themes/15/company.spcolor</dev:code> <maml:remarks> <maml:para>Removes the file company.spcolor</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Remove-PnPFile -SiteRelativeUrl _catalogs/themes/15/company.spcolor -Recycle</dev:code> <maml:remarks> <maml:para>Removes the file company.spcolor and saves it to the Recycle Bin</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPFileFromProvisioningTemplate</command:name> <maml:description> <maml:para>Removes a file from a PnP Provisioning Template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPFileFromProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPFileFromProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filename to read the template from, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The relative File Path of the file to remove from the in-memory template</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while saving the template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="1"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The relative File Path of the file to remove from the in-memory template</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filename to read the template from, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while saving the template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPFileFromProvisioningTemplate -Path template.pnp -FilePath filePath</dev:code> <maml:remarks> <maml:para>Removes a file from an in-memory PnP Provisioning Template</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPFolder</command:name> <maml:description> <maml:para>Deletes a folder within a parent folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPFolder</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The folder name</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The parent folder in the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recycle</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The parent folder in the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The folder name</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recycle</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPFolder -Name NewFolder -Folder _catalogs/masterpage</dev:code> <maml:remarks> <maml:para>Removes the folder 'NewFolder' from '_catalogsmasterpage'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPFolder -Name NewFolder -Folder _catalogs/masterpage -Recycle</dev:code> <maml:remarks> <maml:para>Removes the folder 'NewFolder' from '_catalogsmasterpage' and is saved in the Recycle Bin</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPGroup</command:name> <maml:description> <maml:para>Removes a group from a web.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPGroup</maml:name> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A group object, an ID or a name of a group to remove</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A group object, an ID or a name of a group to remove</maml:para> </maml:description> <command:parameterValue required="false">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPGroup -Identity "My Users"</dev:code> <maml:remarks> <maml:para>Removes the group "My Users"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPHomeSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes the currently set site as the home site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPHomeSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPHomeSite</maml:name> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPHomeSite</dev:code> <maml:remarks> <maml:para>Removes the currently set site as the home site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPHubSiteAssociation</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Disconnects a site from a hubsite.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPHubSiteAssociation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Disconnects an site from a hubsite</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPHubSiteAssociation</maml:name> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to disconnect from its hubsite</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to disconnect from its hubsite</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> <dev:type> <maml:name>SitePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPHubSiteAssociation -Site https://tenant.sharepoint.com/sites/mysite</dev:code> <maml:remarks> <maml:para>This example adds the specified site to the hubsite.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPJavaScriptLink</command:name> <maml:description> <maml:para>Removes a JavaScript link or block from a web or sitecollection</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPJavaScriptLink</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPJavaScriptLink</maml:name> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use the -Force flag to bypass the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the JavaScriptLink is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Name or id of the JavaScriptLink to remove. Omit if you want to remove all JavaScript Links.</maml:para> </maml:description> <command:parameterValue required="true">UserCustomActionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use the -Force flag to bypass the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Name or id of the JavaScriptLink to remove. Omit if you want to remove all JavaScript Links.</maml:para> </maml:description> <command:parameterValue required="false">UserCustomActionPipeBind</command:parameterValue> <dev:type> <maml:name>UserCustomActionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the JavaScriptLink is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection.</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPJavaScriptLink -Identity jQuery</dev:code> <maml:remarks> <maml:para>Removes the injected JavaScript file with the name jQuery from the current web after confirmation</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPJavaScriptLink -Identity jQuery -Scope Site</dev:code> <maml:remarks> <maml:para>Removes the injected JavaScript file with the name jQuery from the current site collection after confirmation</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPJavaScriptLink -Identity jQuery -Scope Site -Confirm:$false</dev:code> <maml:remarks> <maml:para>Removes the injected JavaScript file with the name jQuery from the current site collection and will not ask for confirmation</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPJavaScriptLink -Scope Site</dev:code> <maml:remarks> <maml:para>Removes all the injected JavaScript files from the current site collection after confirmation for each of them</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPJavaScriptLink -Identity faea0ce2-f0c2-4d45-a4dc-73898f3c2f2e -Scope All</dev:code> <maml:remarks> <maml:para>Removes the injected JavaScript file with id faea0ce2-f0c2-4d45-a4dc-73898f3c2f2e from both the Web and Site scopes</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPJavaScriptLink -Scope All | ? Sequence -gt 1000 | Remove-PnPJavaScriptLink</dev:code> <maml:remarks> <maml:para>Removes all the injected JavaScript files from both the Web and Site scope that have a sequence number higher than 1000</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPList</command:name> <maml:description> <maml:para>Deletes a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPList</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or Title of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recycle</maml:name> <maml:description> <maml:para>Defines if the list should be moved to recycle bin or directly deleted.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or Title of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recycle</maml:name> <maml:description> <maml:para>Defines if the list should be moved to recycle bin or directly deleted.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPList -Identity Announcements</dev:code> <maml:remarks> <maml:para>Removes the list named 'Announcements'. Asks for confirmation.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPList -Identity Announcements -Force</dev:code> <maml:remarks> <maml:para>Removes the list named 'Announcements' without asking for confirmation.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPList -Title Announcements -Recycle</dev:code> <maml:remarks> <maml:para>Removes the list named 'Announcements' and saves to the Recycle Bin</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPListItem</command:name> <maml:description> <maml:para>Deletes an item from a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPListItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPListItem</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recycle</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> <dev:type> <maml:name>ListItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Recycle</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPListItem -List "Demo List" -Identity "1" -Force</dev:code> <maml:remarks> <maml:para>Removes the listitem with id "1" from the "Demo List" list.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPListItem -List "Demo List" -Identity "1" -Force -Recycle</dev:code> <maml:remarks> <maml:para>Removes the listitem with id "1" from the "Demo List" list and saves it in the Recycle Bin.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPNavigationNode</command:name> <maml:description> <maml:para>Removes a menu item from either the quicklaunch or top navigation</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPNavigationNode</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPNavigationNode</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id or node object to delete</maml:para> </maml:description> <command:parameterValue required="true">NavigationNodePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-PnPNavigationNode</maml:name> <command:parameter required="true" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Specifying the All parameter will remove all the nodes from specified Location.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Specifying the All parameter will remove all the nodes from specified Location.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id or node object to delete</maml:para> </maml:description> <command:parameterValue required="true">NavigationNodePipeBind</command:parameterValue> <dev:type> <maml:name>NavigationNodePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPNavigationNode -Identity 1032</dev:code> <maml:remarks> <maml:para>Removes the navigation node with the specified id</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $nodes = Get-PnPNavigationNode -QuickLaunch PS:>$nodes | Select-Object -First 1 | Remove-PnPNavigationNode -Force</dev:code> <maml:remarks> <maml:para>Retrieves all navigation nodes from the Quick Launch navigation, then removes the first node in the list and it will not ask for a confirmation</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPNavigationNode -Title Recent -Location QuickLaunch</dev:code> <maml:remarks> <maml:para>Will remove the recent navigation node from the quick launch in the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPNavigationNode -Title Home -Location TopNavigationBar -Force</dev:code> <maml:remarks> <maml:para>Will remove the home navigation node from the top navigation bar without prompting for a confirmation in the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPNavigationNode -Location QuickLaunch | Remove-PnPNavigationNode -Force</dev:code> <maml:remarks> <maml:para>Will remove all the navigation nodes from the quick launch bar without prompting for a confirmation in the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPOrgAssetsLibrary</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes a given document library as a organizational asset source</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPOrgAssetsLibrary</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes a given document library as a organizational asset source based on its server relative URL in your Sharepoint Online Tenant. It will not remove the document library itself. It may take some time before this change will be reflected in the webinterface.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPOrgAssetsLibrary</maml:name> <command:parameter required="true" position="named"> <maml:name>LibraryUrl</maml:name> <maml:description> <maml:para>The server relative url of the document library flagged as organizational asset which you want to remove, i.e. "sites/branding/logos"</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldRemoveFromCdn</maml:name> <maml:description> <maml:para>Boolean indicating if the document library that will no longer be flagged as an organizational asset also needs to be removed as an Office 365 CDN source</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>Indicates what type of Office 365 CDN source the document library that will no longer be flagged as an organizational asset was of</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>Indicates what type of Office 365 CDN source the document library that will no longer be flagged as an organizational asset was of</maml:para> </maml:description> <command:parameterValue required="false">SPOTenantCdnType</command:parameterValue> <dev:type> <maml:name>SPOTenantCdnType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>LibraryUrl</maml:name> <maml:description> <maml:para>The server relative url of the document library flagged as organizational asset which you want to remove, i.e. "sites/branding/logos"</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShouldRemoveFromCdn</maml:name> <maml:description> <maml:para>Boolean indicating if the document library that will no longer be flagged as an organizational asset also needs to be removed as an Office 365 CDN source</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPOrgAssetsLibrary -LibraryUrl "sites/branding/logos"</dev:code> <maml:remarks> <maml:para>This example removes the document library with the url "logos" residing in the sitecollection with the url "sites/branding/logos" from the list with organizational assets keeping it as an Office 365 CDN source</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPOrgAssetsLibrary -LibraryUrl "sites/branding/logos" -ShouldRemoveFromCdn $true</dev:code> <maml:remarks> <maml:para>This example removes the document library with the url "logos" residing in the sitecollection with the url "sites/branding/logos" from the list with organizational assets also removing it as a Public Office 365 CDN source</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPOrgAssetsLibrary -LibraryUrl "sites/branding/logos" -ShouldRemoveFromCdn $true -CdnType Private</dev:code> <maml:remarks> <maml:para>This example removes the document library with the url "logos" residing in the sitecollection with the url "sites/branding/logos" from the list with organizational assets also removing it as a Private Office 365 CDN source</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPOrgNewsSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes a given site from the list of organizational news sites.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPOrgNewsSite</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes a given site from the list of organizational news sites based on its URL in your Sharepoint Online Tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPOrgNewsSite</maml:name> <command:parameter required="true" position="named"> <maml:name>OrgNewsSiteUrl</maml:name> <maml:description> <maml:para>The site to be removed from list of organization's news sites</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>OrgNewsSiteUrl</maml:name> <maml:description> <maml:para>The site to be removed from list of organization's news sites</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> <dev:type> <maml:name>SitePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPOrgNewsSite -OrgNewsSiteUrl https://tenant.sharepoint.com/sites/mysite</dev:code> <maml:remarks> <maml:para>This example removes the specified site from list of organization's news sites.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPStorageEntity</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Remove Storage Entities / Farm Properties from either the tenant scoped app catalog or the current site collection if the site has a site collection scoped app catalog</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPStorageEntity</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPStorageEntity</maml:name> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the value to remove.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines the scope of the storage entity. Defaults to Tenant.</maml:para> </maml:description> <command:parameterValue required="true">StorageEntityScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the value to remove.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines the scope of the storage entity. Defaults to Tenant.</maml:para> </maml:description> <command:parameterValue required="false">StorageEntityScope</command:parameterValue> <dev:type> <maml:name>StorageEntityScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPStorageEntity -Key MyKey </dev:code> <maml:remarks> <maml:para>Removes an existing storage entity / farm property</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPStorageEntity -Key MyKey -Scope Site</dev:code> <maml:remarks> <maml:para>Removes an existing storage entity from the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPPropertyBagValue</command:name> <maml:description> <maml:para>Removes a value from the property bag</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPPropertyBagValue</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPPropertyBagValue</maml:name> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key of the property bag value to be removed</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site relative url of the folder. See examples for use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site relative url of the folder. See examples for use.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key of the property bag value to be removed</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPPropertyBagValue -Key MyKey</dev:code> <maml:remarks> <maml:para>This will remove the value with key MyKey from the current web property bag</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPPropertyBagValue -Key MyKey -Folder /MyFolder</dev:code> <maml:remarks> <maml:para>This will remove the value with key MyKey from the folder MyFolder which is located in the root folder of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPPropertyBagValue -Key MyKey -Folder /</dev:code> <maml:remarks> <maml:para>This will remove the value with key MyKey from the root folder of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPPublishingImageRendition</command:name> <maml:description> <maml:para>Removes an existing image rendition</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPPublishingImageRendition</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPPublishingImageRendition</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The display name or id of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true">ImageRenditionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to remove the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to remove the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The display name or id of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true">ImageRenditionPipeBind</command:parameterValue> <dev:type> <maml:name>ImageRenditionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPPublishingImageRendition -Name "MyImageRendition" -Width 800 -Height 600</dev:code> <maml:remarks> <maml:para /> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPRoleDefinition</command:name> <maml:description> <maml:para>Remove a Role Definition from a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPRoleDefinition</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPRoleDefinition</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the role definition, either a RoleDefinition object or a the name of roledefinition</maml:para> </maml:description> <command:parameterValue required="true">RoleDefinitionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation to delete the role definition</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation to delete the role definition</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the role definition, either a RoleDefinition object or a the name of roledefinition</maml:para> </maml:description> <command:parameterValue required="true">RoleDefinitionPipeBind</command:parameterValue> <dev:type> <maml:name>RoleDefinitionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPRoleDefinition -Identity MyRoleDefinition</dev:code> <maml:remarks> <maml:para>Removes the specified Role Definition (Permission Level) from the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPSearchConfiguration</command:name> <maml:description> <maml:para>Remove the search configuration</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPSearchConfiguration</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPSearchConfiguration</maml:name> <command:parameter required="true" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Search configuration string</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SearchConfigurationScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-PnPSearchConfiguration</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to a search configuration</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SearchConfigurationScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Search configuration string</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to a search configuration</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SearchConfigurationScope</command:parameterValue> <dev:type> <maml:name>SearchConfigurationScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPSearchConfiguration -Configuration $config</dev:code> <maml:remarks> <maml:para>Remove the search configuration for the current web (does not remove managed property mappings)</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPSearchConfiguration -Configuration $config -Scope Site</dev:code> <maml:remarks> <maml:para>Remove the search configuration for the current site collection (does not remove managed property mappings)</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPSearchConfiguration -Configuration $config -Scope Subscription</dev:code> <maml:remarks> <maml:para>Remove the search configuration for the current tenant (does not remove managed property mappings)</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPSearchConfiguration -Path searchconfig.xml -Scope Subscription</dev:code> <maml:remarks> <maml:para>Reads the search configuration from the specified XML file and remove it for the current tenant (does not remove managed property mappings)</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPTenantSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes a site collection</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPTenantSite</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes a site collection which is listed in your tenant administration site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPTenantSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the full URL of the site collection that needs to be deleted</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipRecycleBin</maml:name> <maml:description> <maml:para>Do not add to the tenant scoped recycle bin when selected.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SkipRecycleBin</maml:name> <maml:description> <maml:para>Do not add to the tenant scoped recycle bin when selected.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the full URL of the site collection that needs to be deleted</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso</dev:code> <maml:remarks> <maml:para>This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' and put it in the recycle bin.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso -Force -SkipRecycleBin</dev:code> <maml:remarks> <maml:para>This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' with force and it will skip the recycle bin.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPTenantSite -Url https://tenant.sharepoint.com/sites/contoso -FromRecycleBin</dev:code> <maml:remarks> <maml:para>This will remove the site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the recycle bin.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPSiteClassification</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes one or more existing site classification values from the list of available values. Requires a connection to the Microsoft Graph</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPSiteClassification</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPSiteClassification</maml:name> <command:parameter required="true" position="named"> <maml:name>Classifications</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Specifying the Confirm parameter will allow the confirmation question to be skipped</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Classifications</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Specifying the Confirm parameter will allow the confirmation question to be skipped</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" PS:> Remove-PnPSiteClassification -Classifications "HBI"</dev:code> <maml:remarks> <maml:para>Removes the "HBI" site classification from the list of available values.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" PS:> Remove-PnPSiteClassification -Classifications "HBI", "Top Secret"</dev:code> <maml:remarks> <maml:para>Removes the "HBI" site classification from the list of available values.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPSiteCollectionAdmin</command:name> <maml:description> <maml:para>Removes one or more users as site collection administrators from the site collection in the current context</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPSiteCollectionAdmin</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command allows removing one to many users as site collection administrators from the site collection in the current context. All existing site collection administrators not included in this command will remain site collection administrator.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPSiteCollectionAdmin</maml:name> <command:parameter required="true" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies owner(s) to remove as site collection administrators. Can be both users and groups.</maml:para> </maml:description> <command:parameterValue required="true">UserPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies owner(s) to remove as site collection administrators. Can be both users and groups.</maml:para> </maml:description> <command:parameterValue required="true">UserPipeBind</command:parameterValue> <dev:type> <maml:name>UserPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPSiteCollectionAdmin -Owners "user@contoso.onmicrosoft.com"</dev:code> <maml:remarks> <maml:para>This will remove user@contoso.onmicrosoft.com as a site collection owner from the site collection in the current context</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPSiteCollectionAdmin -Owners @("user1@contoso.onmicrosoft.com", "user2@contoso.onmicrosoft.com")</dev:code> <maml:remarks> <maml:para>This will remove user1@contoso.onmicrosoft.com and user2@contoso.onmicrosoft.com as site collection owners from the site collection in the current context</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUser | ? Title -Like "*Doe" | Remove-PnPSiteCollectionAdmin</dev:code> <maml:remarks> <maml:para>This will remove all users with their title ending with "Doe" as site collection owners from the site collection in the current context</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteCollectionAdmin | Remove-PnPSiteCollectionAdmin</dev:code> <maml:remarks> <maml:para>This will remove all existing site collection administrators from the site collection in the current context</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPSiteCollectionAppCatalog</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes a Site Collection scoped App Catalog from a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPSiteCollectionAppCatalog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Notice that this will not remove the App Catalog list and its contents from the site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPSiteCollectionAppCatalog</maml:name> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>Url of the site to remove the app catalog from.</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>Url of the site to remove the app catalog from.</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> <dev:type> <maml:name>SitePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPSiteCollectionAppCatalog -Site "https://contoso.sharepoint.com/sites/FinanceTeamsite"</dev:code> <maml:remarks> <maml:para>This will remove a SiteCollection app catalog from the specified site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPSiteDesign</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes a Site Design</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPSiteDesign</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPSiteDesign</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the site design to remove</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified you will not be asked to confirm removing the specified Site Design</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified you will not be asked to confirm removing the specified Site Design</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the site design to remove</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> <dev:type> <maml:name>TenantSiteDesignPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd</dev:code> <maml:remarks> <maml:para>Removes the specified site design</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPSiteDesignTask</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes a Site Design Task. If the execution of the associated site script has already started the execution will not be terminated.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPSiteDesignTask</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPSiteDesignTask</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the site design to remove</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignTaskPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified you will not be asked to confirm removing the specified Site Design</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified you will not be asked to confirm removing the specified Site Design</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the site design to remove</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignTaskPipeBind</command:parameterValue> <dev:type> <maml:name>TenantSiteDesignTaskPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPSiteDesignTask -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd</dev:code> <maml:remarks> <maml:para>Removes the specified site design task</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPSiteScript</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes a Site Script</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPSiteScript</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPSiteScript</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the Site Script to remove</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteScriptPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified you will not be asked to confirm removing the specified Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified you will not be asked to confirm removing the specified Site Script</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the Site Script to remove</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteScriptPipeBind</command:parameterValue> <dev:type> <maml:name>TenantSiteScriptPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPSiteScript -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd</dev:code> <maml:remarks> <maml:para>Removes the specified site script</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPStoredCredential</command:name> <maml:description> <maml:para>Removes a credential</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPStoredCredential</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes a stored credential from the Windows Credential Manager</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPStoredCredential</maml:name> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The credential to remove</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified you will not be asked for confirmation</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified you will not be asked for confirmation</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The credential to remove</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPStoredCredential -Name https://tenant.sharepoint.com</dev:code> <maml:remarks> <maml:para>Removes the specified credential from the Windows Credential Manager</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPTaxonomyItem</command:name> <maml:description> <maml:para>Removes a taxonomy item</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPTaxonomyItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPTaxonomyItem</maml:name> <command:parameter required="true" position="named"> <maml:name>TermPath</maml:name> <maml:description> <maml:para>The path, delimited by | of the taxonomy item to remove, alike GROUPLABEL|TERMSETLABEL|TERMLABEL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermPath</maml:name> <maml:description> <maml:para>The path, delimited by | of the taxonomy item to remove, alike GROUPLABEL|TERMSETLABEL|TERMLABEL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPTenantCdnOrigin</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes an origin from the Public or Private content delivery network (CDN).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPTenantCdnOrigin</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes an origin from the Public or Private content delivery network (CDN). You must be a SharePoint Online global administrator to run the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPTenantCdnOrigin</maml:name> <command:parameter required="true" position="named"> <maml:name>OriginUrl</maml:name> <maml:description> <maml:para>The origin to remove.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>The cdn type to remove the origin from.</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>The cdn type to remove the origin from.</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> <dev:type> <maml:name>SPOTenantCdnType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>OriginUrl</maml:name> <maml:description> <maml:para>The origin to remove.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPTenantCdnOrigin -OriginUrl /sites/site/subfolder -CdnType Public</dev:code> <maml:remarks> <maml:para>This example removes the specified origin from the public CDN</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPTenantTheme</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes a theme</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPTenantTheme</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes the specified theme from the tenant configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPTenantTheme</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the theme to retrieve</maml:para> </maml:description> <command:parameterValue required="true">ThemePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the theme to retrieve</maml:para> </maml:description> <command:parameterValue required="true">ThemePipeBind</command:parameterValue> <dev:type> <maml:name>ThemePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPTenantTheme -Name "MyCompanyTheme"</dev:code> <maml:remarks> <maml:para>Removes the specified theme.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPTermGroup</command:name> <maml:description> <maml:para>Removes a taxonomy term group and all its containing termsets</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPTermGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPTermGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of the taxonomy term group to delete.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to use; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of the taxonomy term group to delete.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TermStoreName</maml:name> <maml:description> <maml:para>Term store to use; if not specified the default term store is used.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPUnifiedGroup</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes one Office 365 Group (aka Unified Group). Requires the Azure Active Directory application permission 'Group.ReadWrite.All'.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPUnifiedGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPUnifiedGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Office 365 Group</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Office 365 Group</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> <dev:type> <maml:name>UnifiedGroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPUnifiedGroup -Identity $groupId</dev:code> <maml:remarks> <maml:para>Removes an Office 365 Group based on its ID</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPUnifiedGroup -Identity $group</dev:code> <maml:remarks> <maml:para>Removes the provided Office 365 Group</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUnifiedGroup | ? Visibility -eq "Public" | Remove-PnPUnifiedGroup</dev:code> <maml:remarks> <maml:para>Removes all the public Office 365 Groups</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPUser</command:name> <maml:description> <maml:para>Removes a specific user from the site collection User Information List</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This command will allow the removal of a specific user from the User Information List</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPUser</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>User ID or login name</maml:para> </maml:description> <command:parameterValue required="true">UserPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Specifying the Confirm parameter will allow the confirmation question to be skipped</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Specifying the Confirm parameter will allow the confirmation question to be skipped</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>User ID or login name</maml:para> </maml:description> <command:parameterValue required="true">UserPipeBind</command:parameterValue> <dev:type> <maml:name>UserPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.User</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPUser -Identity 23</dev:code> <maml:remarks> <maml:para>Remove the user with Id 23 from the User Information List of the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPUser -Identity i:0#.f|membership|user@tenant.onmicrosoft.com</dev:code> <maml:remarks> <maml:para>Remove the user with LoginName i:0#.f|membership|user@tenant.onmicrosoft.com from the User Information List of the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPUser | ? Email -eq "user@tenant.onmicrosoft.com" | Remove-PnPUser</dev:code> <maml:remarks> <maml:para>Remove the user with e-mail address user@tenant.onmicrosoft.com from the User Information List of the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPUser -Identity i:0#.f|membership|user@tenant.onmicrosoft.com -Confirm:$false</dev:code> <maml:remarks> <maml:para>Remove the user with LoginName i:0#.f|membership|user@tenant.onmicrosoft.com from the User Information List of the current site collection without asking to confirm the removal first</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPUserFromGroup</command:name> <maml:description> <maml:para>Removes a user from a group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPUserFromGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPUserFromGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>A valid login name of a user (user@company.com)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A group object, an ID or a name of a group</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A group object, an ID or a name of a group</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>A valid login name of a user (user@company.com)</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPUserFromGroup -LoginName user@company.com -GroupName 'Marketing Site Members'</dev:code> <maml:remarks> <maml:para>Removes the user user@company.com from the Group 'Marketing Site Members'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPView</command:name> <maml:description> <maml:para>Deletes a view from a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPView</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPView</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or Title of the view.</maml:para> </maml:description> <command:parameterValue required="true">ViewPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or Title of the view.</maml:para> </maml:description> <command:parameterValue required="true">ViewPipeBind</command:parameterValue> <dev:type> <maml:name>ViewPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPView -List "Demo List" -Identity "All Items"</dev:code> <maml:remarks> <maml:para>Removes the view with title "All Items" from the "Demo List" list.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPWeb</command:name> <maml:description> <maml:para>Removes a subweb in the current web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPWeb</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPWeb</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The site relative url of the web, e.g. 'Subweb1'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation to delete the subweb</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-PnPWeb</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity/Id/Web object to delete</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation to delete the subweb</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation to delete the subweb</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity/Id/Web object to delete</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The site relative url of the web, e.g. 'Subweb1'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPWeb -Url projectA</dev:code> <maml:remarks> <maml:para>Remove a web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPWeb -Identity 5fecaf67-6b9e-4691-a0ff-518fc9839aa0</dev:code> <maml:remarks> <maml:para>Remove a web specified by its ID</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSubWebs | Remove-PnPWeb -Force</dev:code> <maml:remarks> <maml:para>Remove all subwebs and do not ask for confirmation</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPWebhookSubscription</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Removes a Webhook subscription from the resource</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPWebhookSubscription</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPWebhookSubscription</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the Webhook subscription to remove</maml:para> </maml:description> <command:parameterValue required="true">WebhookSubscriptionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name which the Webhook subscription will be removed from</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the Webhook subscription to remove</maml:para> </maml:description> <command:parameterValue required="true">WebhookSubscriptionPipeBind</command:parameterValue> <dev:type> <maml:name>WebhookSubscriptionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name which the Webhook subscription will be removed from</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OfficeDevPnP.Core.Entities.WebhookSubscription</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPWebhookSubscription -List MyList -Identity ea1533a8-ff03-415b-a7b6-517ee50db8b6</dev:code> <maml:remarks> <maml:para>Removes the Webhook subscription with the specified id from the list MyList</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $subscriptions = Get-PnPWebhookSubscriptions -List MyList PS:> Remove-PnPWebhookSubscription -Identity $subscriptions[0] -List MyList</dev:code> <maml:remarks> <maml:para>Removes the first Webhook subscription from the list MyList</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $subscriptions = Get-PnPWebhookSubscriptions -List MyList PS:> $subscriptions[0] | Remove-PnPWebhookSubscription -List MyList</dev:code> <maml:remarks> <maml:para>Removes the first Webhook subscription from the list MyList</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPWebPart</command:name> <maml:description> <maml:para>Removes a web part from a page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPWebPart</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPWebPart</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Guid of the web part</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Server relative url of the web part page, e.g. /sites/demo/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-PnPWebPart</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The name of the web part</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Server relative url of the web part page, e.g. /sites/demo/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Guid of the web part</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Server relative url of the web part page, e.g. /sites/demo/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The name of the web part</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82</dev:code> <maml:remarks> <maml:para>This will remove the web part specified by ID to the specified page in the first row and the first column of the HTML table present on the page</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Title MyWebpart</dev:code> <maml:remarks> <maml:para>This will remove the web part specified by title to the specified page in the first row and the first column of the HTML table present on the page</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPWikiPage</command:name> <maml:description> <maml:para>Removes a wiki page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPWikiPage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPWikiPage</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-PnPWikiPage</maml:name> <command:parameter required="true" position="named"> <maml:name>SiteRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SiteRelativePageUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPWikiPage -PageUrl '/pages/wikipage.aspx'</dev:code> <maml:remarks> <maml:para>Removes the page '/pages/wikipage.aspx'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPWorkflowDefinition</command:name> <maml:description> <maml:para>Removes a workflow definition</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPWorkflowDefinition</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPWorkflowDefinition</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The definition to remove</maml:para> </maml:description> <command:parameterValue required="true">WorkflowDefinitionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The definition to remove</maml:para> </maml:description> <command:parameterValue required="true">WorkflowDefinitionPipeBind</command:parameterValue> <dev:type> <maml:name>WorkflowDefinitionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPWorkflowDefinition -Identity $wfDef</dev:code> <maml:remarks> <maml:para>Removes the workflow, retrieved by Get-PnPWorkflowDefinition, from the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWorkflowDefinition -Name MyWorkflow | Remove-PnPWorkflowDefinition</dev:code> <maml:remarks> <maml:para>Get the workflow MyWorkFlow and remove from the site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-PnPWorkflowSubscription</command:name> <maml:description> <maml:para>Remove workflow subscription</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>PnPWorkflowSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes a previously registered workflow subscription</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PnPWorkflowSubscription</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The subscription to remove</maml:para> </maml:description> <command:parameterValue required="true">WorkflowSubscriptionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The subscription to remove</maml:para> </maml:description> <command:parameterValue required="true">WorkflowSubscriptionPipeBind</command:parameterValue> <dev:type> <maml:name>WorkflowSubscriptionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Remove-PnPWorkflowSubscription -identity $wfSub</dev:code> <maml:remarks> <maml:para>Removes the workflowsubscription, retrieved by Get-PnPWorkflowSubscription.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPWorkflowSubscription -Name MyWorkflow | Remove-PnPWorkflowSubscription</dev:code> <maml:remarks> <maml:para>Get the workflowSubscription MyWorkFlow and remove it.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Rename-PnPFile</command:name> <maml:description> <maml:para>Renames a file in its current location</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Rename</command:verb> <command:noun>PnPFile</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Rename-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para>Server relative Url specifying the file to rename. Must include the file name.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>TargetFileName</maml:name> <maml:description> <maml:para>File name to rename the file to. Should only be the file name and not include the path to its location. Use Move-PnPFile to move the file to another location.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteIfAlreadyExists</maml:name> <maml:description> <maml:para>If provided, if a file already exist with the provided TargetFileName, it will be overwritten. If omitted, the rename operation will be canceled if a file already exists with the TargetFileName file name.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be requested and the action will be performed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Rename-PnPFile</maml:name> <command:parameter required="true" position="named"> <maml:name>SiteRelativeUrl</maml:name> <maml:description> <maml:para>Site relative Url specifying the file to rename. Must include the file name.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>TargetFileName</maml:name> <maml:description> <maml:para>File name to rename the file to. Should only be the file name and not include the path to its location. Use Move-PnPFile to move the file to another location.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteIfAlreadyExists</maml:name> <maml:description> <maml:para>If provided, if a file already exist with the provided TargetFileName, it will be overwritten. If omitted, the rename operation will be canceled if a file already exists with the TargetFileName file name.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be requested and the action will be performed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be requested and the action will be performed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OverwriteIfAlreadyExists</maml:name> <maml:description> <maml:para>If provided, if a file already exist with the provided TargetFileName, it will be overwritten. If omitted, the rename operation will be canceled if a file already exists with the TargetFileName file name.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para>Server relative Url specifying the file to rename. Must include the file name.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SiteRelativeUrl</maml:name> <maml:description> <maml:para>Site relative Url specifying the file to rename. Must include the file name.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>TargetFileName</maml:name> <maml:description> <maml:para>File name to rename the file to. Should only be the file name and not include the path to its location. Use Move-PnPFile to move the file to another location.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Rename-PnPFile -ServerRelativeUrl /sites/project/Documents/company.docx -TargetFileName mycompany.docx</dev:code> <maml:remarks> <maml:para>Renames a file named company.docx located in the document library called Documents located in the projects sitecollection under the managed path sites to mycompany.docx. If a file named mycompany.aspx already exists, it won't perform the rename.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Rename-PnPFile -SiteRelativeUrl Documents/company.aspx -TargetFileName mycompany.docx</dev:code> <maml:remarks> <maml:para>Renames a file named company.docx located in the document library called Documents located in the current site to mycompany.aspx. If a file named mycompany.aspx already exists, it won't perform the rename.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Rename-PnPFile -ServerRelativeUrl /sites/project/Documents/company.docx -TargetFileName mycompany.docx -OverwriteIfAlreadyExists</dev:code> <maml:remarks> <maml:para>Renames a file named company.docx located in the document library called Documents located in the projects sitecollection under the managed path sites to mycompany.aspx. If a file named mycompany.aspx already exists, it will still perform the rename and replace the original mycompany.aspx file.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Rename-PnPFolder</command:name> <maml:description> <maml:para>Renames a folder</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Rename</command:verb> <command:noun>PnPFolder</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Rename-PnPFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder to rename</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TargetFolderName</maml:name> <maml:description> <maml:para>The new folder name</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder to rename</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TargetFolderName</maml:name> <maml:description> <maml:para>The new folder name</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Rename-PnPFolder -Folder Documents/Reports -TargetFolderName 'Archived Reports'</dev:code> <maml:remarks> <maml:para>This will rename the folder Reports in the Documents library to 'Archived Reports'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Request-PnPAccessToken</command:name> <maml:description> <maml:para>Requests an OAuth Access token</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Request</command:verb> <command:noun>PnPAccessToken</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns an access token using the password grant, using the PnP O365 Management Shell client id by default and the AllSites.FullControl scope by default.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Request-PnPAccessToken</maml:name> <command:parameter required="false" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The Azure Application Client Id to use to retrieve the token. Defaults to the PnP Office 365 Management Shell</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The scopes to retrieve the token for. Defaults to AllSites.FullControl</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The scopes to retrieve the token for. Defaults to AllSites.FullControl</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Decoded</maml:name> <maml:description> <maml:para>Returns the token in a decoded / human readible manner</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetAsCurrent</maml:name> <maml:description> <maml:para>Set this token as the current token to use when performing Azure AD based authentication requests with PnP PowerShell</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Optional credentials to use when retrieving the access token. If not present you need to connect first with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TenantUrl</maml:name> <maml:description> <maml:para>Optional tenant URL to use when retrieving the access token. The Url should be in the shape of https://yourtenant.sharepoint.com. See examples for more info.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The Azure Application Client Id to use to retrieve the token. Defaults to the PnP Office 365 Management Shell</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Optional credentials to use when retrieving the access token. If not present you need to connect first with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Decoded</maml:name> <maml:description> <maml:para>Returns the token in a decoded / human readible manner</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The scopes to retrieve the token for. Defaults to AllSites.FullControl</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The scopes to retrieve the token for. Defaults to AllSites.FullControl</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetAsCurrent</maml:name> <maml:description> <maml:para>Set this token as the current token to use when performing Azure AD based authentication requests with PnP PowerShell</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TenantUrl</maml:name> <maml:description> <maml:para>Optional tenant URL to use when retrieving the access token. The Url should be in the shape of https://yourtenant.sharepoint.com. See examples for more info.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Request-PnPAccessToken</dev:code> <maml:remarks> <maml:para>Returns the access token using the default client id and scope</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Request-PnPAccessToken -ClientId 26e29fec-aa10-4f99-8381-d96cddc650c2</dev:code> <maml:remarks> <maml:para>Returns the access token using the specified client id and the default scope of AllSites.FullControl</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Request-PnPAccessToken -ClientId 26e29fec-aa10-4f99-8381-d96cddc650c2 -Scopes Group.ReadWrite.All</dev:code> <maml:remarks> <maml:para>Returns the access token using the specified client id and the specified scope</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Request-PnPAccessToken -ClientId 26e29fec-aa10-4f99-8381-d96cddc650c2 -Scopes Group.ReadWrite.All, AllSites.FullControl</dev:code> <maml:remarks> <maml:para>Returns the access token using the specified client id and the specified scopes</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $token = Request-PnPAccessToken -ClientId 26e29fec-aa10-4f99-8381-d96cddc650c2 -Resource https://contoso.sharepoint.com -Credentials (Get-Credential) -TenantUrl https://contoso.sharepoint.com Connect-PnPOnline -AccessToken $token</dev:code> <maml:remarks> <maml:para>Returns the access token using the specified client id and the specified scopes while using the credentials and tenanturl specified to authentication against Azure AD</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Request-PnPReIndexList</command:name> <maml:description> <maml:para>Marks the list for full indexing during the next incremental crawl</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Request</command:verb> <command:noun>PnPReIndexList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Request-PnPReIndexList</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Request-PnPReIndexList -Identity "Demo List"</dev:code> <maml:remarks> <maml:para /> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Request-PnPReIndexWeb</command:name> <maml:description> <maml:para>Marks the web for full indexing during the next incremental crawl</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Request</command:verb> <command:noun>PnPReIndexWeb</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Request-PnPReIndexWeb</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Reset-PnPFileVersion</command:name> <maml:description> <maml:para>Resets a file to its previous version</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>PnPFileVersion</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Reset-PnPFileVersion</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para>The server relative URL of the file.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckinType</maml:name> <maml:description> <maml:para>The check in type to use. Defaults to Major.</maml:para> </maml:description> <command:parameterValue required="true">CheckinType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckInComment</maml:name> <maml:description> <maml:para>The comment added to the checkin. Defaults to 'Restored to previous version'.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>CheckInComment</maml:name> <maml:description> <maml:para>The comment added to the checkin. Defaults to 'Restored to previous version'.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckinType</maml:name> <maml:description> <maml:para>The check in type to use. Defaults to Major.</maml:para> </maml:description> <command:parameterValue required="false">CheckinType</command:parameterValue> <dev:type> <maml:name>CheckinType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para>The server relative URL of the file.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Reset-PnPFileVersion -ServerRelativeUrl "/sites/test/office365.png"</dev:code> <maml:remarks> <maml:para /> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Reset-PnPFileVersion -ServerRelativeUrl "/sites/test/office365.png" -CheckinType MajorCheckin -Comment "Restored to previous version"</dev:code> <maml:remarks> <maml:para /> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Reset-PnPLabel</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Resets a label/tag on the specified list or library to None</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>PnPLabel</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Reset-PnPLabel</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SyncToItems</maml:name> <maml:description> <maml:para>Reset label on existing items in the library</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SyncToItems</maml:name> <maml:description> <maml:para>Reset label on existing items in the library</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Reset-PnPLabel -List "Demo List"</dev:code> <maml:remarks> <maml:para>This resets an O365 label on the specified list or library to None</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Reset-PnPLabel -List "Demo List" -SyncToItems $true</dev:code> <maml:remarks> <maml:para>This resets an O365 label on the specified list or library to None and resets the label on all the items in the list and library except Folders and where the label has been manually or previously automatically assigned</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Resolve-PnPFolder</command:name> <maml:description> <maml:para>Returns a folder from a given site relative path, and will create it if it does not exist.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resolve</command:verb> <command:noun>PnPFolder</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns a folder from a given site relative path, and will create it if it does not exist. If you do not want the folder to be created, for instance just to test if a folder exists, use Get-PnPFolder</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resolve-PnPFolder</maml:name> <command:parameter required="true" position="named"> <maml:name>SiteRelativePath</maml:name> <maml:description> <maml:para>Site Relative Folder Path</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Specify properties to include when retrieving objects from the server.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>SiteRelativePath</maml:name> <maml:description> <maml:para>Site Relative Folder Path</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>The web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Folder</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Resolve-PnPFolder -SiteRelativePath "demofolder/subfolder"</dev:code> <maml:remarks> <maml:para>Creates a folder called subfolder in a folder called demofolder located in the root folder of the site. If the folder hierarchy does not exist, it will be created.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PnPFolder:</maml:linkText> <maml:uri>https://github.com/OfficeDev/PnP-PowerShell/blob/master/Documentation/GetPnPFolder.md</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restore-PnPDeletedUnifiedGroup</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Restores one deleted Office 365 Group (aka Unified Group)</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Restore</command:verb> <command:noun>PnPDeletedUnifiedGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Restore-PnPDeletedUnifiedGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the deleted Office 365 Group</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the deleted Office 365 Group</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> <dev:type> <maml:name>UnifiedGroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Restore-PnPDeletedUnifiedGroup -Identity 38b32e13-e900-4d95-b860-fb52bc07ca7f</dev:code> <maml:remarks> <maml:para>Restores a deleted Office 365 Group based on its ID</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $group = Get-PnPDeletedUnifiedGroup -Identity 38b32e13-e900-4d95-b860-fb52bc07ca7f PS:> Restore-PnPDeletedUnifiedGroup -Identity $group</dev:code> <maml:remarks> <maml:para>Restores the provided deleted Office 365 Group</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restore-PnPRecycleBinItem</command:name> <maml:description> <maml:para>Restores the provided recycle bin item to its original location</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Restore</command:verb> <command:noun>PnPRecycleBinItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Restore-PnPRecycleBinItem</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id of the recycle bin item or the recycle bin item object itself to restore</maml:para> </maml:description> <command:parameterValue required="true">RecycleBinItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to restore the recycle bin item</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Restore-PnPRecycleBinItem</maml:name> <command:parameter required="true" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>If provided all items will be stored </maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to restore the recycle bin item</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>If provided all items will be stored </maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to restore the recycle bin item</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id of the recycle bin item or the recycle bin item object itself to restore</maml:para> </maml:description> <command:parameterValue required="true">RecycleBinItemPipeBind</command:parameterValue> <dev:type> <maml:name>RecycleBinItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Restore-PnpRecycleBinItem -Identity 72e4d749-d750-4989-b727-523d6726e442</dev:code> <maml:remarks> <maml:para>Restores the recycle bin item with Id 72e4d749-d750-4989-b727-523d6726e442 to its original location</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPRecycleBinItem | ? -Property LeafName -like "*.docx" | Restore-PnpRecycleBinItem</dev:code> <maml:remarks> <maml:para>Restores all the items in the first and second stage recycle bins to their original location of which the filename ends with the .docx extension</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restore-PnPTenantRecycleBinItem</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Restores a site collection from the tenant scoped recycle bin</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Restore</command:verb> <command:noun>PnPTenantRecycleBinItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Restore-PnPTenantRecycleBinItem cmdlet allows a site collection that has been deleted and still exists in the tenant recycle bin to be restored to its original location.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restore-PnPTenantRecycleBinItem</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the site collection to restore from the tenant recycle bin</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If provided, the PowerShell execution will halt until the site restore process has completed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to restore the site collection from the tenant recycle bin</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to restore the site collection from the tenant recycle bin</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the site collection to restore from the tenant recycle bin</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If provided, the PowerShell execution will halt until the site restore process has completed</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Restore-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso</dev:code> <maml:remarks> <maml:para>This will restore the deleted site collection with the url 'https://tenant.sharepoint.com/sites/contoso' to its original location</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Restore-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso -Wait</dev:code> <maml:remarks> <maml:para>This will restore the deleted site collection with the url 'https://tenant.sharepoint.com/sites/contoso' to its original location and will wait with executing further PowerShell commands until the site collection restore has completed</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Resume-PnPWorkflowInstance</command:name> <maml:description> <maml:para>Resume a workflow</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resume</command:verb> <command:noun>PnPWorkflowInstance</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Resumes a previously stopped workflow instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resume-PnPWorkflowInstance</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The instance to resume</maml:para> </maml:description> <command:parameterValue required="true">WorkflowInstancePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The instance to resume</maml:para> </maml:description> <command:parameterValue required="true">WorkflowInstancePipeBind</command:parameterValue> <dev:type> <maml:name>WorkflowInstancePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Resume-PnPWorkflowInstance -identity $wfInstance</dev:code> <maml:remarks> <maml:para>Resumes the workflow instance, this can be the Guid of the instance or the instance itself.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Revoke-PnPHubSiteRights</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Revoke permissions to the permissions already in place to associate sites to Hub Sites for one or more specific users</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Revoke</command:verb> <command:noun>PnPHubSiteRights</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Revoke-PnPHubSiteRights</maml:name> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Revoke-PnPHubSiteRights -Identity https://contoso.sharepoint.com/sites/hubsite -Principals "myuser@mydomain.com","myotheruser@mydomain.com"</dev:code> <maml:remarks> <maml:para>This example shows how to revoke the rights of myuser and myotheruser to associate their sites with the provided Hub Site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Revoke-PnPSiteDesignRights</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Revokes the specified principals rights to use the site design.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Revoke</command:verb> <command:noun>PnPSiteDesignRights</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Revoke-PnPSiteDesignRights</maml:name> <command:parameter required="true" position="named"> <maml:name>Principals</maml:name> <maml:description> <maml:para>One or more principals to revoke.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The site design to use.</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The site design to use.</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> <dev:type> <maml:name>TenantSiteDesignPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Principals</maml:name> <maml:description> <maml:para>One or more principals to revoke.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Revoke-PnPSiteDesignRights -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd -Principals "myuser@mydomain.com","myotheruser@mydomain.com"</dev:code> <maml:remarks> <maml:para>Revokes rights to the specified principals on the site design specified</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd | Revoke-PnPSiteDesignRights -Principals "myuser@mydomain.com","myotheruser@mydomain.com"</dev:code> <maml:remarks> <maml:para>Revokes rights to the specified principals on the site design specified</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Revoke-PnPTenantServicePrincipalPermission</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Revokes a permission that was previously granted to the "SharePoint Online Client" service principal.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Revoke</command:verb> <command:noun>PnPTenantServicePrincipalPermission</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Revokes a permission that was previously granted to the "SharePoint Online Client" service principal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Revoke-PnPTenantServicePrincipalPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Save-PnPClientSidePageConversionLog</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Persists the current client side page conversion log data to the loggers linked to the last used page transformation run. Needs to be used in conjunction with the -LogSkipFlush flag on the ConvertTo-PnPClientSidePage cmdlet</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Save</command:verb> <command:noun>PnPClientSidePageConversionLog</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Save-PnPClientSidePageConversionLog</maml:name> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Save-PnPClientSidePageConversionLog</dev:code> <maml:remarks> <maml:para>Persists the current client side page conversion log data to the loggers linked to the last used page transformation run. Needs to be used in conjunction with the -LogSkipFlush flag on the ConvertTo-PnPClientSidePage cmdlet</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Save-PnPProvisioningTemplate</command:name> <maml:description> <maml:para>Saves a PnP site template to the file system</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Save</command:verb> <command:noun>PnPProvisioningTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Save-PnPProvisioningTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Allows you to provide an in-memory instance of the ProvisioningTemplate type of the PnP Core Component. When using this parameter, the -Out parameter refers to the path for saving the template and storing any supporting file for the template.</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningTemplate</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify the ITemplateProviderExtension to execute while saving a template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Allows you to provide an in-memory instance of the ProvisioningTemplate type of the PnP Core Component. When using this parameter, the -Out parameter refers to the path for saving the template and storing any supporting file for the template.</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningTemplate</command:parameterValue> <dev:type> <maml:name>ProvisioningTemplate</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify the ITemplateProviderExtension to execute while saving a template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Save-PnPSiteTemplate -InputInstance $template -Out .\template.pnp</dev:code> <maml:remarks> <maml:para>Saves a PnP site template to the file system as a PnP file.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Save-PnPTenantTemplate</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Saves a PnP provisioning hierarchy to the file system</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Save</command:verb> <command:noun>PnPTenantTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Save-PnPTenantTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Allows you to provide an in-memory instance of a Tenant Template. When using this parameter, the -Out parameter refers to the path for saving the template and storing any supporting file for the template.</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningHierarchy</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Allows you to provide an in-memory instance of a Tenant Template. When using this parameter, the -Out parameter refers to the path for saving the template and storing any supporting file for the template.</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningHierarchy</command:parameterValue> <dev:type> <maml:name>ProvisioningHierarchy</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Save-PnPTenantTemplate -Template $template -Out .\tenanttemplate.pnp</dev:code> <maml:remarks> <maml:para>Saves a PnP tenant template to the file system</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Send-PnPMail</command:name> <maml:description> <maml:para>Sends an email using the Office 365 SMTP Service or SharePoint, depending on the parameters specified. See detailed help for more information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Send</command:verb> <command:noun>PnPMail</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Send-PnPMail</maml:name> <command:parameter required="true" position="named"> <maml:name>To</maml:name> <maml:description> <maml:para>List of recipients</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Subject of the email</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Body</maml:name> <maml:description> <maml:para>Body of the email</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>From</maml:name> <maml:description> <maml:para>If using from address, you also have to provide a password</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>If using a password, you also have to provide the associated from address</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Cc</maml:name> <maml:description> <maml:para>List of recipients on CC</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Body</maml:name> <maml:description> <maml:para>Body of the email</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Cc</maml:name> <maml:description> <maml:para>List of recipients on CC</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>From</maml:name> <maml:description> <maml:para>If using from address, you also have to provide a password</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>If using a password, you also have to provide the associated from address</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Subject of the email</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>To</maml:name> <maml:description> <maml:para>List of recipients</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Send-PnPMail -To address@tenant.sharepointonline.com -Subject test -Body test</dev:code> <maml:remarks> <maml:para>Sends an e-mail using the SharePoint SendEmail method using the current context. E-mail is sent from the system account and can only be sent to accounts in the same tenant</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Send-PnPMail -To address@contoso.com -Subject test -Body test -From me@tenant.onmicrosoft.com -Password xyz</dev:code> <maml:remarks> <maml:para>Sends an e-mail via Office 365 SMTP and requires a from address and password. E-mail is sent from the from user and can be sent to both internal and external addresses.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Send-PnPMail -To address@contoso.com -Subject test -Body test -From me@server.net -Password xyz -Server yoursmtp.server.net</dev:code> <maml:remarks> <maml:para>Sends an e-mail via a custom SMTP server and requires a from address and password. E-mail is sent from the from user.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPApplicationCustomizer</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Updates a SharePoint Framework client side extension application customizer</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPApplicationCustomizer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Updates a SharePoint Framework client side extension application customizer by updating its custom action. Only the properties that will be provided will be updated. Others will remain as they are.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPApplicationCustomizer</maml:name> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the CustomAction representing the client side extension registration is to be found at the web or site collection scope. Specify All to update the component on both web and site collection level.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the application customizer. Omit to not update this property.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the application customizer. Omit to not update this property.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this application customizer being injected. Use when you have a specific sequence with which to have multiple application customizers being added to the page. Omit to not update this property.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties of the application customizer to update. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}". Omit to not update this property.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id or name of the CustomAction representing the client side extension registration that needs to be updated or a CustomAction instance itself</maml:para> </maml:description> <command:parameterValue required="true">UserCustomActionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPApplicationCustomizer</maml:name> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest for which existing custom action(s) should be updated</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the CustomAction representing the client side extension registration is to be found at the web or site collection scope. Specify All to update the component on both web and site collection level.</maml:para> </maml:description> <command:parameterValue required="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the application customizer. Omit to not update this property.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the application customizer. Omit to not update this property.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this application customizer being injected. Use when you have a specific sequence with which to have multiple application customizers being added to the page. Omit to not update this property.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties of the application customizer to update. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}". Omit to not update this property.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest for which existing custom action(s) should be updated</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties of the application customizer to update. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}". Omit to not update this property.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the application customizer. Omit to not update this property.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id or name of the CustomAction representing the client side extension registration that needs to be updated or a CustomAction instance itself</maml:para> </maml:description> <command:parameterValue required="false">UserCustomActionPipeBind</command:parameterValue> <dev:type> <maml:name>UserCustomActionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Define if the CustomAction representing the client side extension registration is to be found at the web or site collection scope. Specify All to update the component on both web and site collection level.</maml:para> </maml:description> <command:parameterValue required="false">CustomActionScope</command:parameterValue> <dev:type> <maml:name>CustomActionScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this application customizer being injected. Use when you have a specific sequence with which to have multiple application customizers being added to the page. Omit to not update this property.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the application customizer. Omit to not update this property.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2</dev:code> <maml:remarks> <maml:para>Updates the custom action representing the client side extension registration with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPCustomAction -ClientSideComponentId aa66f67e-46c0-4474-8a82-42bf467d07f2 -Scope web -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"}</dev:code> <maml:remarks> <maml:para>Updates the custom action(s) properties being registered for a SharePoint Framework solution having the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' in its manifest from the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPAppSideLoading</command:name> <maml:description> <maml:para>Enables the App SideLoading Feature on a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPAppSideLoading</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPAppSideLoading</maml:name> <command:parameter required="true" position="named"> <maml:name>On</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPAppSideLoading</maml:name> <command:parameter required="true" position="named"> <maml:name>Off</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Off</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>On</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPAppSideLoading -On</dev:code> <maml:remarks> <maml:para>This will turn on App side loading</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPAppSideLoading -Off</dev:code> <maml:remarks> <maml:para>This will turn off App side loading</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPAuditing</command:name> <maml:description> <maml:para>Set Auditing setting for a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPAuditing</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPAuditing</maml:name> <command:parameter required="false" position="named"> <maml:name>RetentionTime</maml:name> <maml:description> <maml:para>Set the retention time</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TrimAuditLog</maml:name> <maml:description> <maml:para>Trim the audit log</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EditItems</maml:name> <maml:description> <maml:para>Audit editing items</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckOutCheckInItems</maml:name> <maml:description> <maml:para>Audit checking out or checking in items</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MoveCopyItems</maml:name> <maml:description> <maml:para>Audit moving or copying items to another location in the site.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DeleteRestoreItems</maml:name> <maml:description> <maml:para>Audit deleting or restoring items</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EditContentTypesColumns</maml:name> <maml:description> <maml:para>Audit editing content types and columns</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchContent</maml:name> <maml:description> <maml:para>Audit searching site content</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EditUsersPermissions</maml:name> <maml:description> <maml:para>Audit editing users and permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPAuditing</maml:name> <command:parameter required="true" position="named"> <maml:name>EnableAll</maml:name> <maml:description> <maml:para>Enable all audit flags</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetentionTime</maml:name> <maml:description> <maml:para>Set the retention time</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TrimAuditLog</maml:name> <maml:description> <maml:para>Trim the audit log</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPAuditing</maml:name> <command:parameter required="true" position="named"> <maml:name>DisableAll</maml:name> <maml:description> <maml:para>Disable all audit flags</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>CheckOutCheckInItems</maml:name> <maml:description> <maml:para>Audit checking out or checking in items</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DeleteRestoreItems</maml:name> <maml:description> <maml:para>Audit deleting or restoring items</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>DisableAll</maml:name> <maml:description> <maml:para>Disable all audit flags</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EditContentTypesColumns</maml:name> <maml:description> <maml:para>Audit editing content types and columns</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EditItems</maml:name> <maml:description> <maml:para>Audit editing items</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EditUsersPermissions</maml:name> <maml:description> <maml:para>Audit editing users and permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>EnableAll</maml:name> <maml:description> <maml:para>Enable all audit flags</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MoveCopyItems</maml:name> <maml:description> <maml:para>Audit moving or copying items to another location in the site.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RetentionTime</maml:name> <maml:description> <maml:para>Set the retention time</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchContent</maml:name> <maml:description> <maml:para>Audit searching site content</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TrimAuditLog</maml:name> <maml:description> <maml:para>Trim the audit log</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPAuditing -EnableAll</dev:code> <maml:remarks> <maml:para>Enables all auditing settings for the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPAuditing -DisableAll</dev:code> <maml:remarks> <maml:para>Disables all auditing settings for the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPAuditing -RetentionTime 7</dev:code> <maml:remarks> <maml:para>Sets the audit log trimming to 7 days, this also enables the automatic trimming of the audit log</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPAuditing -TrimAuditLog</dev:code> <maml:remarks> <maml:para>Enables the automatic trimming of the audit log</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPAuditing -RetentionTime 7 -CheckOutCheckInItems -MoveCopyItems -SearchContent</dev:code> <maml:remarks> <maml:para>Sets the audit log trimming to 7 days, this also enables the automatic trimming of the audit log. Do auditing for: - Checking out or checking in items - Moving or copying items to another location in the site - Searching site content</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPAvailablePageLayouts</command:name> <maml:description> <maml:para>Sets the available page layouts for the current site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPAvailablePageLayouts</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPAvailablePageLayouts</maml:name> <command:parameter required="true" position="named"> <maml:name>PageLayouts</maml:name> <maml:description> <maml:para>An array of page layout files to set as available page layouts for the site.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPAvailablePageLayouts</maml:name> <command:parameter required="true" position="named"> <maml:name>AllowAllPageLayouts</maml:name> <maml:description> <maml:para>An array of page layout files to set as available page layouts for the site.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPAvailablePageLayouts</maml:name> <command:parameter required="true" position="named"> <maml:name>InheritPageLayouts</maml:name> <maml:description> <maml:para>Set the available page layouts to inherit from the parent site.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>AllowAllPageLayouts</maml:name> <maml:description> <maml:para>An array of page layout files to set as available page layouts for the site.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InheritPageLayouts</maml:name> <maml:description> <maml:para>Set the available page layouts to inherit from the parent site.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PageLayouts</maml:name> <maml:description> <maml:para>An array of page layout files to set as available page layouts for the site.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPClientSidePage</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Sets parameters of a Client-Side Page</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPClientSidePage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPClientSidePage</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name/identity of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Sets the name of the page.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Sets the title of the page.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LayoutType</maml:name> <maml:description> <maml:para>Sets the layout type of the page. (Default = Article)</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePageLayoutType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PromoteAs</maml:name> <maml:description> <maml:para>Allows to promote the page for a specific purpose (HomePage | NewsPage)</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePromoteType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CommentsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables the comments on the page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Publishes the page once it is saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HeaderType</maml:name> <maml:description> <maml:para>Sets the page header type</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePageHeaderType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specify either the name, ID or an actual content type.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>Thumbnail Url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ServerRelativeImageUrl</maml:name> <maml:description> <maml:para>The URL of the image to show in the header</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TranslateX</maml:name> <maml:description> <maml:para>A value defining how to translate the image on the x-axis</maml:para> </maml:description> <command:parameterValue required="true">Double</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TranslateY</maml:name> <maml:description> <maml:para>A value defining how to translate the image on the y-axis</maml:para> </maml:description> <command:parameterValue required="true">Double</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>CommentsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables the comments on the page</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specify either the name, ID or an actual content type.</maml:para> </maml:description> <command:parameterValue required="false">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HeaderType</maml:name> <maml:description> <maml:para>Sets the page header type</maml:para> </maml:description> <command:parameterValue required="false">ClientSidePageHeaderType</command:parameterValue> <dev:type> <maml:name>ClientSidePageHeaderType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name/identity of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> <dev:type> <maml:name>ClientSidePagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LayoutType</maml:name> <maml:description> <maml:para>Sets the layout type of the page. (Default = Article)</maml:para> </maml:description> <command:parameterValue required="false">ClientSidePageLayoutType</command:parameterValue> <dev:type> <maml:name>ClientSidePageLayoutType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Sets the name of the page.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PromoteAs</maml:name> <maml:description> <maml:para>Allows to promote the page for a specific purpose (HomePage | NewsPage)</maml:para> </maml:description> <command:parameterValue required="false">ClientSidePagePromoteType</command:parameterValue> <dev:type> <maml:name>ClientSidePagePromoteType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Publishes the page once it is saved.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ServerRelativeImageUrl</maml:name> <maml:description> <maml:para>The URL of the image to show in the header</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>Thumbnail Url</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Sets the title of the page.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TranslateX</maml:name> <maml:description> <maml:para>A value defining how to translate the image on the x-axis</maml:para> </maml:description> <command:parameterValue required="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TranslateY</maml:name> <maml:description> <maml:para>A value defining how to translate the image on the y-axis</maml:para> </maml:description> <command:parameterValue required="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPClientSidePage -Identity "MyPage" -LayoutType Home -Title "My Page"</dev:code> <maml:remarks> <maml:para>Updates the properties of the Client-Side page named 'MyPage'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPClientSidePage -Identity "MyPage" -CommentsEnabled</dev:code> <maml:remarks> <maml:para>Enables the comments on the Client-Side page named 'MyPage'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPClientSidePage -Identity "MyPage" -CommentsEnabled:$false</dev:code> <maml:remarks> <maml:para>Disables the comments on the Client-Side page named 'MyPage'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPClientSidePage -Identity "MyPage" -HeaderType Default</dev:code> <maml:remarks> <maml:para>Sets the header of the page to the default header</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPClientSidePage -Identity "MyPage" -HeaderType None</dev:code> <maml:remarks> <maml:para>Removes the header of the page</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPClientSidePage -Identity "MyPage" -HeaderType Custom -ServerRelativeImageUrl "/sites/demo1/assets/myimage.png" -TranslateX 10.5 -TranslateY 11.0</dev:code> <maml:remarks> <maml:para>Sets the header of the page to custom header, using the specified image and translates the location of the image in the header given the values specified</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPClientSideText</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Set Client-Side Text Component properties</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPClientSideText</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets the rendered text in existing client side text component</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPClientSideText</maml:name> <command:parameter required="true" position="named"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>The instance id of the text component</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Text</maml:name> <maml:description> <maml:para>Text to set</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>The instance id of the text component</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> <dev:type> <maml:name>ClientSidePagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Text</maml:name> <maml:description> <maml:para>Text to set</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSetClientSideText -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 -Text "MyText"</dev:code> <maml:remarks> <maml:para>Sets the text of the client side text component.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPClientSideWebPart</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Set Client-Side Web Part properties</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPClientSideWebPart</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets specific client side web part properties. Notice that the title parameter will only set the -internal- title of web part. The title which is shown in the UI will, if possible, have to be set using the PropertiesJson parameter. Use Get-PnPClientSideComponent to retrieve the instance id and properties of a web part.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPClientSideWebPart</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the web part. This can be the web part instance id or the title of a web part</maml:para> </maml:description> <command:parameterValue required="true">ClientSideWebPartPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Sets the internal title of the web part. Notice that this will NOT set a visible title.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PropertiesJson</maml:name> <maml:description> <maml:para>Sets the properties as a JSON string.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the web part. This can be the web part instance id or the title of a web part</maml:para> </maml:description> <command:parameterValue required="true">ClientSideWebPartPipeBind</command:parameterValue> <dev:type> <maml:name>ClientSideWebPartPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true">ClientSidePagePipeBind</command:parameterValue> <dev:type> <maml:name>ClientSidePagePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PropertiesJson</maml:name> <maml:description> <maml:para>Sets the properties as a JSON string.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Sets the internal title of the web part. Notice that this will NOT set a visible title.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPClientSideWebPart -Page Home -Identity a2875399-d6ff-43a0-96da-be6ae5875f82 -PropertiesJson $myproperties</dev:code> <maml:remarks> <maml:para>Sets the properties of the client side web part given in the $myproperties variable.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPContext</command:name> <maml:description> <maml:para>Set the ClientContext</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPContext</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets the Client Context to use by the cmdlets, which allows easy context switching. See examples for details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPContext</maml:name> <command:parameter required="true" position="1"> <maml:name>Context</maml:name> <maml:description> <maml:para>The ClientContext to set</maml:para> </maml:description> <command:parameterValue required="true">ClientContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="1"> <maml:name>Context</maml:name> <maml:description> <maml:para>The ClientContext to set</maml:para> </maml:description> <command:parameterValue required="true">ClientContext</command:parameterValue> <dev:type> <maml:name>ClientContext</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url $siteAurl -Credentials $credentials PS:> $ctx = Get-PnPContext PS:> Get-PnPList # returns the lists from site specified with $siteAurl PS:> Connect-PnPOnline -Url $siteBurl -Credentials $credentials PS:> Get-PnPList # returns the lists from the site specified with $siteBurl PS:> Set-PnPContext -Context $ctx # switch back to site A PS:> Get-PnPList # returns the lists from site A</dev:code> <maml:remarks> <maml:para /> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPDefaultColumnValues</command:name> <maml:description> <maml:para>Sets default column values for a document library</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPDefaultColumnValues</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets default column values for a document library, per folder, or for the root folder if the folder parameter has not been specified. Supports both text and taxonomy fields.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPDefaultColumnValues</maml:name> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The internal name, id or a reference to a field</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>A list of values. In case of a text field the values will be concatenated, separated by a semi-colon. In case of a taxonomy field multiple values will added. In case of people field multiple values will be added.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Name or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>A library relative folder path, if not specified it will set the default column values on the root folder of the library ('/')</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The internal name, id or a reference to a field</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>A library relative folder path, if not specified it will set the default column values on the root folder of the library ('/')</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Name or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>A list of values. In case of a text field the values will be concatenated, separated by a semi-colon. In case of a taxonomy field multiple values will added. In case of people field multiple values will be added.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPDefaultColumnValues -List Documents -Field TaxKeyword -Value "Company|Locations|Stockholm"</dev:code> <maml:remarks> <maml:para>Sets a default value for the enterprise keywords field on a library to a term called "Stockholm", located in the "Locations" term set, which is part of the "Company" term group</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPDefaultColumnValues -List Documents -Field TaxKeyword -Value "15c4c4e4-4b67-4894-a1d8-de5ff811c791"</dev:code> <maml:remarks> <maml:para>Sets a default value for the enterprise keywords field on a library to a term with the id "15c4c4e4-4b67-4894-a1d8-de5ff811c791". You need to ensure the term is valid for the field.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPDefaultColumnValues -List Documents -Field MyTextField -Value "DefaultValue" -Folder "My folder"</dev:code> <maml:remarks> <maml:para>Sets a default value for the MyTextField text field on the folder "My folder" in a library to a value of "DefaultValue"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPDefaultColumnValues -List Documents -Field MyPeopleField -Value "1;#Foo Bar"</dev:code> <maml:remarks> <maml:para>Sets a default value for the MyPeopleField people field on a library to a value of "Foo Bar" using the id from the user information list.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $user = New-PnPUser -LoginName foobar@contoso.com PS:> Set-PnPDefaultColumnValues -List Documents -Field MyPeopleField -Value "$($user.Id);#$($user.LoginName)"</dev:code> <maml:remarks> <maml:para>Sets a default value for the MyPeopleField people field on a library to a value of "Foo Bar" using the id from the user information list.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $user1 = New-PnPUser -LoginName user1@contoso.com PS:> $user2 = New-PnPUser -LoginName user2@contoso.com PS:> Set-PnPDefaultColumnValues -List Documents -Field MyMultiPeopleField -Value "$($user1.Id);#$($user1.LoginName)","$($user2.Id);#$($user2.LoginName)"</dev:code> <maml:remarks> <maml:para>Sets a default value for the MyMultiPeopleField people field on a library to a value of "User 1" and "User 2" using the id from the user information list.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPDefaultContentTypeToList</command:name> <maml:description> <maml:para>Sets the default content type for a list</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPDefaultContentTypeToList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPDefaultContentTypeToList</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The name of a list, an ID or the actual list object to update</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type object that needs to be set as the default content type on the list. Content Type needs to be present on the list.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type object that needs to be set as the default content type on the list. Content Type needs to be present on the list.</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The name of a list, an ID or the actual list object to update</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPDefaultContentTypeToList -List "Project Documents" -ContentType "Project"</dev:code> <maml:remarks> <maml:para>This will set the Project content type (which has already been added to a list) as the default content type</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPDefaultPageLayout</command:name> <maml:description> <maml:para>Sets a specific page layout to be the default page layout for a publishing site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPDefaultPageLayout</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPDefaultPageLayout</maml:name> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title of the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPDefaultPageLayout</maml:name> <command:parameter required="true" position="named"> <maml:name>InheritFromParentSite</maml:name> <maml:description> <maml:para>Set the default page layout to be inherited from the parent site.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>InheritFromParentSite</maml:name> <maml:description> <maml:para>Set the default page layout to be inherited from the parent site.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title of the page layout</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPDefaultPageLayout -Title projectpage.aspx</dev:code> <maml:remarks> <maml:para>Sets projectpage.aspx to be the default page layout for the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPDefaultPageLayout -Title test/testpage.aspx</dev:code> <maml:remarks> <maml:para>Sets a page layout in a folder in the Master Page & Page Layout gallery, such as _catalog/masterpage/test/testpage.aspx, to be the default page layout for the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPDefaultPageLayout -InheritFromParentSite</dev:code> <maml:remarks> <maml:para>Sets the default page layout to be inherited from the parent site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPField</command:name> <maml:description> <maml:para>Changes one or more properties of a field in a specific list or for the whole web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPField</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPField</maml:name> <command:parameter required="true" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Hashtable of properties to update on the field. Use the syntax @{property1="value";property2="value"}.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The field object, internal field name (case sensitive) or field id to update</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object, name or id where to update the field. If omitted the field will be updated on the web.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UpdateExistingLists</maml:name> <maml:description> <maml:para>If provided, the field will be updated on existing lists that use it as well. If not provided or set to $false, existing lists using the field will remain unchanged but new lists will get the updated field.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The field object, internal field name (case sensitive) or field id to update</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object, name or id where to update the field. If omitted the field will be updated on the web.</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UpdateExistingLists</maml:name> <maml:description> <maml:para>If provided, the field will be updated on existing lists that use it as well. If not provided or set to $false, existing lists using the field will remain unchanged but new lists will get the updated field.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Hashtable of properties to update on the field. Use the syntax @{property1="value";property2="value"}.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Field</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPField -Identity AssignedTo -Values @{JSLink="customrendering.js";Group="My fields"}</dev:code> <maml:remarks> <maml:para>Updates the AssignedTo field on the current web to use customrendering.js for the JSLink and sets the group name the field is categorized in to "My Fields". Lists that are already using the AssignedTo field will not be updated.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPField -Identity AssignedTo -Values @{JSLink="customrendering.js";Group="My fields"} -UpdateExistingLists</dev:code> <maml:remarks> <maml:para>Updates the AssignedTo field on the current web to use customrendering.js for the JSLink and sets the group name the field is categorized in to "My Fields". Lists that are already using the AssignedTo field will also be updated.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPField -List "Tasks" -Identity "AssignedTo" -Values @{JSLink="customrendering.js"}</dev:code> <maml:remarks> <maml:para>Updates the AssignedTo field on the Tasks list to use customrendering.js for the JSLink</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPDocumentSetField</command:name> <maml:description> <maml:para>Sets a site column from the available content types to a document set</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPDocumentSetField</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPDocumentSetField</maml:name> <command:parameter required="true" position="named"> <maml:name>DocumentSet</maml:name> <maml:description> <maml:para>The document set in which to set the field. Either specify a name, a document set template object, an id, or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The field to set. The field needs to be available in one of the available content types. Either specify a name, an id or a field object</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSharedField</maml:name> <maml:description> <maml:para>Set the field as a Shared Field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetWelcomePageField</maml:name> <maml:description> <maml:para>Set the field as a Welcome Page field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveSharedField</maml:name> <maml:description> <maml:para>Removes the field as a Shared Field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveWelcomePageField</maml:name> <maml:description> <maml:para>Removes the field as a Welcome Page Field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>DocumentSet</maml:name> <maml:description> <maml:para>The document set in which to set the field. Either specify a name, a document set template object, an id, or a content type object</maml:para> </maml:description> <command:parameterValue required="true">DocumentSetPipeBind</command:parameterValue> <dev:type> <maml:name>DocumentSetPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Field</maml:name> <maml:description> <maml:para>The field to set. The field needs to be available in one of the available content types. Either specify a name, an id or a field object</maml:para> </maml:description> <command:parameterValue required="true">FieldPipeBind</command:parameterValue> <dev:type> <maml:name>FieldPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveSharedField</maml:name> <maml:description> <maml:para>Removes the field as a Shared Field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveWelcomePageField</maml:name> <maml:description> <maml:para>Removes the field as a Welcome Page Field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetSharedField</maml:name> <maml:description> <maml:para>Set the field as a Shared Field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetWelcomePageField</maml:name> <maml:description> <maml:para>Set the field as a Welcome Page field</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPDocumentSetField -Field "Test Field" -DocumentSet "Test Document Set" -SetSharedField -SetWelcomePageField</dev:code> <maml:remarks> <maml:para>This will set the field, available in one of the available content types, as a Shared Field and as a Welcome Page Field.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPDocumentSetField -Field "Test Field" -DocumentSet "Test Document Set" -RemoveSharedField -RemoveWelcomePageField</dev:code> <maml:remarks> <maml:para>This will remove the field, available in one of the available content types, as a Shared Field and as a Welcome Page Field.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPFileCheckedIn</command:name> <maml:description> <maml:para>Checks in a file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPFileCheckedIn</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPFileCheckedIn</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The server relative url of the file to check in</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckinType</maml:name> <maml:description> <maml:para>The check in type to use. Defaults to Major</maml:para> </maml:description> <command:parameterValue required="true">CheckinType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>The check in comment</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Approve</maml:name> <maml:description> <maml:para>Approve file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Approve</maml:name> <maml:description> <maml:para>Approve file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CheckinType</maml:name> <maml:description> <maml:para>The check in type to use. Defaults to Major</maml:para> </maml:description> <command:parameterValue required="false">CheckinType</command:parameterValue> <dev:type> <maml:name>CheckinType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>The check in comment</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The server relative url of the file to check in</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Set-PnPFileCheckedIn -Url "/Documents/Contract.docx"</dev:code> <maml:remarks> <maml:para>Checks in the file "Contract.docx" in the "Documents" library</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Set-PnPFileCheckedIn -Url "/Documents/Contract.docx" -CheckinType MinorCheckin -Comment "Smaller changes"</dev:code> <maml:remarks> <maml:para>Checks in the file "Contract.docx" in the "Documents" library as a minor version and adds the check in comment "Smaller changes"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPFileCheckedOut</command:name> <maml:description> <maml:para>Checks out a file</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPFileCheckedOut</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPFileCheckedOut</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The server relative url of the file to check out</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The server relative url of the file to check out</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:>Set-PnPFileCheckedOut -Url "/sites/testsite/subsite/Documents/Contract.docx"</dev:code> <maml:remarks> <maml:para>Checks out the file "Contract.docx" in the "Documents" library.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPFolderPermission</command:name> <maml:description> <maml:para>Sets folder permissions. Use Get-PnPRoleDefinition to retrieve all available roles you can add or remove using this cmdlet.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPFolderPermission</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPFolderPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the folder, the server relative URL to the folder or actual Folder object</maml:para> </maml:description> <command:parameterValue required="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list the folder is part of</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InheritPermissions</maml:name> <maml:description> <maml:para>Inherit permissions from the parent, removing unique permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SystemUpdate</maml:name> <maml:description> <maml:para>Update the folder permissions without creating a new version or triggering MS Flow.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPFolderPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the folder, the server relative URL to the folder or actual Folder object</maml:para> </maml:description> <command:parameterValue required="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list the folder is part of</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearExisting</maml:name> <maml:description> <maml:para>Clear all existing permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SystemUpdate</maml:name> <maml:description> <maml:para>Update the folder permissions without creating a new version or triggering MS Flow.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPFolderPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the folder, the server relative URL to the folder or actual Folder object</maml:para> </maml:description> <command:parameterValue required="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list the folder is part of</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearExisting</maml:name> <maml:description> <maml:para>Clear all existing permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SystemUpdate</maml:name> <maml:description> <maml:para>Update the folder permissions without creating a new version or triggering MS Flow.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearExisting</maml:name> <maml:description> <maml:para>Clear all existing permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the folder, the server relative URL to the folder or actual Folder object</maml:para> </maml:description> <command:parameterValue required="true">FolderPipeBind</command:parameterValue> <dev:type> <maml:name>FolderPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InheritPermissions</maml:name> <maml:description> <maml:para>Inherit permissions from the parent, removing unique permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list the folder is part of</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SystemUpdate</maml:name> <maml:description> <maml:para>Update the folder permissions without creating a new version or triggering MS Flow.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPFolderPermission -List 'Shared Documents' -Identity 'Shared Documents\Folder' -User 'user@contoso.com' -AddRole 'Contribute'</dev:code> <maml:remarks> <maml:para>Adds the 'Contribute' permission to the user 'user@contoso.com' for the folder named 'Folder' located in the root of the library 'Shared Documents'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPFolderPermission -List 'Documents' -Identity 'Shared Documents\Folder\Subfolder' -User 'user@contoso.com' -RemoveRole 'Contribute'</dev:code> <maml:remarks> <maml:para>Removes the 'Contribute' permission to the user 'user@contoso.com' for the folder named 'Subfolder' located in the folder 'Folder' which is located in the root of the library 'Shared Documents'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPFolderPermission -List 'Documents' -Identity 'Shared Documents\Folder' -User 'user@contoso.com' -AddRole 'Contribute' -ClearExisting</dev:code> <maml:remarks> <maml:para>Adds the 'Contribute' permission to the user 'user@contoso.com' for the folder named 'Folder' located in the root of the library 'Shared Documents' and removes all other permissions</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPFolder -Url 'Shared Documents\Folder' | Set-PnPFolderPermission -List 'Documents' -InheritPermissions</dev:code> <maml:remarks> <maml:para>Resets permissions for the folder named 'Folder' located in the root of the library 'Shared Documents' to inherit permissions from the library 'Shared Documents'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPGroup</command:name> <maml:description> <maml:para>Updates a group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A group object, an ID or a name of a group</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetAssociatedGroup</maml:name> <maml:description> <maml:para>One of the associated group types (Visitors, Members, Owners</maml:para> </maml:description> <command:parameterValue required="true">AssociatedGroupType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>Name of the permission set to add to this SharePoint group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>Name of the permission set to remove from this SharePoint group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title for the group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>The owner for the group, which can be a user or another group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description for the group</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoAcceptRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether users are automatically added or removed when they make a request</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowMembersEditMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether group members can modify membership in the group</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OnlyAllowMembersViewMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether only group members are allowed to view the list of members in the group</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestToJoinEmail</maml:name> <maml:description> <maml:para>The e-mail address to which membership requests are sent</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>Name of the permission set to add to this SharePoint group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowMembersEditMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether group members can modify membership in the group</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether to allow users to request membership in the group and to allow users to request to leave the group</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoAcceptRequestToJoinLeave</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether users are automatically added or removed when they make a request</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description for the group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A group object, an ID or a name of a group</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OnlyAllowMembersViewMembership</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether only group members are allowed to view the list of members in the group</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>The owner for the group, which can be a user or another group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>Name of the permission set to remove from this SharePoint group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequestToJoinEmail</maml:name> <maml:description> <maml:para>The e-mail address to which membership requests are sent</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SetAssociatedGroup</maml:name> <maml:description> <maml:para>One of the associated group types (Visitors, Members, Owners</maml:para> </maml:description> <command:parameterValue required="false">AssociatedGroupType</command:parameterValue> <dev:type> <maml:name>AssociatedGroupType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title for the group</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPGroup -Identity 'My Site Members' -SetAssociatedGroup Members</dev:code> <maml:remarks> <maml:para>Sets the SharePoint group with the name 'My Site Members' as the associated members group</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPGroup -Identity 'My Site Members' -Owner 'site owners'</dev:code> <maml:remarks> <maml:para>Sets the SharePoint group with the name 'site owners' as the owner of the SharePoint group with the name 'My Site Members'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPGroupPermissions</command:name> <maml:description> <maml:para>Adds and/or removes permissions of a specific SharePoint group</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPGroupPermissions</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPGroupPermissions</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get the permissions of a specific group by name</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to apply the command to.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>Name of the permission set to add to this SharePoint group</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>Name of the permission set to remove from this SharePoint group</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>Name of the permission set to add to this SharePoint group</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get the permissions of a specific group by name</maml:para> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to apply the command to.</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>Name of the permission set to remove from this SharePoint group</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -AddRole Contribute</dev:code> <maml:remarks> <maml:para>Adds the 'Contribute' permission to the SharePoint group with the name 'My Site Members'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -RemoveRole 'Full Control' -AddRole 'Read'</dev:code> <maml:remarks> <maml:para>Removes the 'Full Control' from and adds the 'Contribute' permissions to the SharePoint group with the name 'My Site Members'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -AddRole @('Contribute', 'Design')</dev:code> <maml:remarks> <maml:para>Adds the 'Contribute' and 'Design' permissions to the SharePoint group with the name 'My Site Members'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -RemoveRole @('Contribute', 'Design')</dev:code> <maml:remarks> <maml:para>Removes the 'Contribute' and 'Design' permissions from the SharePoint group with the name 'My Site Members'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPGroupPermissions -Identity 'My Site Members' -List 'MyList' -RemoveRole @('Contribute')</dev:code> <maml:remarks> <maml:para>Removes the 'Contribute' permissions from the list 'MyList' for the group with the name 'My Site Members'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPHideDefaultThemes</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Defines if the default / OOTB themes should be visible to users or not.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPHideDefaultThemes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Use this cmdlet to hide or show the default themes to users You must be a SharePoint Online global administrator to run the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPHideDefaultThemes</maml:name> <command:parameter required="true" position="named"> <maml:name>HideDefaultThemes</maml:name> <maml:description> <maml:para>Defines if the default themes should be visible or hidden</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>HideDefaultThemes</maml:name> <maml:description> <maml:para>Defines if the default themes should be visible or hidden</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPHideDefaultThemes -HideDefaultThemes $true</dev:code> <maml:remarks> <maml:para>This example hides the default themes</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPHideDefaultThemes -HideDefaultThemes $false</dev:code> <maml:remarks> <maml:para>This example shows the default themes</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPHomePage</command:name> <maml:description> <maml:para>Sets the home page of the current web.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPHomePage</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPHomePage</maml:name> <command:parameter required="true" position="named"> <maml:name>RootFolderRelativeUrl</maml:name> <maml:description> <maml:para>The root folder relative url of the homepage, e.g. 'sitepages/home.aspx'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>RootFolderRelativeUrl</maml:name> <maml:description> <maml:para>The root folder relative url of the homepage, e.g. 'sitepages/home.aspx'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPHomePage -RootFolderRelativeUrl SitePages/Home.aspx</dev:code> <maml:remarks> <maml:para>Sets the home page to the home.aspx file which resides in the SitePages library</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPHomeSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Sets the home site for your tenant</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPHomeSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPHomeSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The url of the site to set as the home site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The url of the site to set as the home site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPHomeSite -Url https://yourtenant.sharepoint.com/sites/myhome</dev:code> <maml:remarks> <maml:para>Sets the home site to the provided site collection url</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPHubSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Sets hub site properties</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPHubSite</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Allows configuring a hub site</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPHubSite</maml:name> <command:parameter required="false" position="named"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para>GUID of the SharePoint Site Design which should be applied when a site joins the hub site</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HideNameInNavigation</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequiresJoinApproval</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>HideNameInNavigation</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequiresJoinApproval</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para>GUID of the SharePoint Site Design which should be applied when a site joins the hub site</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPHubSite -Identity https://tenant.sharepoint.com/sites/myhubsite -Title "My New Title"</dev:code> <maml:remarks> <maml:para>Sets the title of the hub site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPHubSite -Identity https://tenant.sharepoint.com/sites/myhubsite -Description "My updated description"</dev:code> <maml:remarks> <maml:para>Sets the description of the hub site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPHubSite -Identity https://tenant.sharepoint.com/sites/myhubsite -SiteDesignId df8a3ef1-9603-44c4-abd9-541aea2fa745</dev:code> <maml:remarks> <maml:para>Sets the site design which should be applied to sites joining the the hub site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPHubSite -Identity https://tenant.sharepoint.com/sites/myhubsite -LogoUrl "https://tenant.sharepoint.com/SiteAssets/Logo.png"</dev:code> <maml:remarks> <maml:para>Sets the logo of the hub site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPIndexedProperties</command:name> <maml:description> <maml:para>Marks values of the propertybag to be indexed by search. Notice that this will overwrite the existing flags, i.e. only the properties you define with the cmdlet will be indexed.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPIndexedProperties</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPIndexedProperties</maml:name> <command:parameter required="true" position="named"> <maml:name>Keys</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Keys</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPInPlaceRecordsManagement</command:name> <maml:description> <maml:para>Activates or deactivates in the place records management feature.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPInPlaceRecordsManagement</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPInPlaceRecordsManagement</maml:name> <command:parameter required="true" position="named"> <maml:name>Enabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Enabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPInPlaceRecordsManagement -Enabled $true</dev:code> <maml:remarks> <maml:para>Activates In Place Records Management</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPInPlaceRecordsManagement -Enabled $false</dev:code> <maml:remarks> <maml:para>Deactivates In Place Records Management</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPLabel</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Sets a label/tag on the specified list or library. Use Reset-PnPLabel to remove the label again.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPLabel</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPLabel</maml:name> <command:parameter required="true" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The name of the label.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SyncToItems</maml:name> <maml:description> <maml:para>Apply label to existing items in the library.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BlockDeletion</maml:name> <maml:description> <maml:para>Block deletion of items in the library.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BlockEdit</maml:name> <maml:description> <maml:para>Block editing of items in the library.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>BlockDeletion</maml:name> <maml:description> <maml:para>Block deletion of items in the library.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BlockEdit</maml:name> <maml:description> <maml:para>Block editing of items in the library.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The name of the label.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SyncToItems</maml:name> <maml:description> <maml:para>Apply label to existing items in the library.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPLabel -List "Demo List" -Label "Project Documentation"</dev:code> <maml:remarks> <maml:para>This sets an O365 label on the specified list or library. </maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPLabel -List "Demo List" -Label "Project Documentation" -SyncToItems $true</dev:code> <maml:remarks> <maml:para>This sets an O365 label on the specified list or library and sets the label to all the items in the list and library as well.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPLabel -List "Demo List" -Label "Project Documentation" -BlockDelete $true -BlockEdit $true</dev:code> <maml:remarks> <maml:para>This sets an O365 label on the specified list or library. Next, it also blocks the ability to either edit or delete the item. </maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPList</command:name> <maml:description> <maml:para>Updates list settings</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPList</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPList</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableContentTypes</maml:name> <maml:description> <maml:para>Set to $true to enable content types, set to $false to disable content types</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BreakRoleInheritance</maml:name> <maml:description> <maml:para>If used the security inheritance is broken for this list</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResetRoleInheritance</maml:name> <maml:description> <maml:para>If used the security inheritance is reset for this list (inherited from parent)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CopyRoleAssignments</maml:name> <maml:description> <maml:para>If used the roles are copied from the parent web</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearSubscopes</maml:name> <maml:description> <maml:para>If used the unique permissions are cleared from child objects and they can inherit role assignments from this object</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the list</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the list</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Hidden</maml:name> <maml:description> <maml:para>Hide the list from the SharePoint UI. Set to $true to hide, $false to show.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForceCheckout</maml:name> <maml:description> <maml:para>Enable or disable force checkout. Set to $true to enable, $false to disable.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListExperience</maml:name> <maml:description> <maml:para>Set the list experience: Auto, NewExperience or ClassicExperience</maml:para> </maml:description> <command:parameterValue required="true">ListExperience</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableAttachments</maml:name> <maml:description> <maml:para>Enable or disable attachments. Set to $true to enable, $false to disable.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableFolderCreation</maml:name> <maml:description> <maml:para>Enable or disable folder creation. Set to $true to enable, $false to disable.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableVersioning</maml:name> <maml:description> <maml:para>Enable or disable versioning. Set to $true to enable, $false to disable.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableMinorVersions</maml:name> <maml:description> <maml:para>Enable or disable minor versions versioning. Set to $true to enable, $false to disable.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MajorVersions</maml:name> <maml:description> <maml:para>Maximum major versions to keep</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinorVersions</maml:name> <maml:description> <maml:para>Maximum minor versions to keep</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableModeration</maml:name> <maml:description> <maml:para>Enable or disable whether content approval is enabled for the list. Set to $true to enable, $false to disable.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>BreakRoleInheritance</maml:name> <maml:description> <maml:para>If used the security inheritance is broken for this list</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearSubscopes</maml:name> <maml:description> <maml:para>If used the unique permissions are cleared from child objects and they can inherit role assignments from this object</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CopyRoleAssignments</maml:name> <maml:description> <maml:para>If used the roles are copied from the parent web</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the list</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableAttachments</maml:name> <maml:description> <maml:para>Enable or disable attachments. Set to $true to enable, $false to disable.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableContentTypes</maml:name> <maml:description> <maml:para>Set to $true to enable content types, set to $false to disable content types</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableFolderCreation</maml:name> <maml:description> <maml:para>Enable or disable folder creation. Set to $true to enable, $false to disable.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableMinorVersions</maml:name> <maml:description> <maml:para>Enable or disable minor versions versioning. Set to $true to enable, $false to disable.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableModeration</maml:name> <maml:description> <maml:para>Enable or disable whether content approval is enabled for the list. Set to $true to enable, $false to disable.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableVersioning</maml:name> <maml:description> <maml:para>Enable or disable versioning. Set to $true to enable, $false to disable.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ForceCheckout</maml:name> <maml:description> <maml:para>Enable or disable force checkout. Set to $true to enable, $false to disable.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Hidden</maml:name> <maml:description> <maml:para>Hide the list from the SharePoint UI. Set to $true to hide, $false to show.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ListExperience</maml:name> <maml:description> <maml:para>Set the list experience: Auto, NewExperience or ClassicExperience</maml:para> </maml:description> <command:parameterValue required="false">ListExperience</command:parameterValue> <dev:type> <maml:name>ListExperience</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MajorVersions</maml:name> <maml:description> <maml:para>Maximum major versions to keep</maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinorVersions</maml:name> <maml:description> <maml:para>Maximum minor versions to keep</maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResetRoleInheritance</maml:name> <maml:description> <maml:para>If used the security inheritance is reset for this list (inherited from parent)</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the list</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-PnPList -Identity "Demo List" -EnableContentTypes $true</dev:code> <maml:remarks> <maml:para>Switches the Enable Content Type switch on the list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-PnPList -Identity "Demo List" -Hidden $true</dev:code> <maml:remarks> <maml:para>Hides the list from the SharePoint UI.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-PnPList -Identity "Demo List" -EnableVersioning $true</dev:code> <maml:remarks> <maml:para>Turns on major versions on a list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-PnPList -Identity "Demo List" -EnableVersioning $true -MajorVersions 20</dev:code> <maml:remarks> <maml:para>Turns on major versions on a list and sets the maximum number of Major Versions to keep to 20.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-PnPList -Identity "Demo Library" -EnableVersioning $true -EnableMinorVersions $true -MajorVersions 20 -MinorVersions 5</dev:code> <maml:remarks> <maml:para>Turns on major versions on a document library and sets the maximum number of Major versions to keep to 20 and sets the maximum of Minor versions to 5.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-PnPList -Identity "Demo List" -EnableAttachments $true</dev:code> <maml:remarks> <maml:para>Turns on attachments on a list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPListInformationRightsManagement</command:name> <maml:description> <maml:para>Get the site closure status of the site which has a site policy applied</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPListInformationRightsManagement</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPListInformationRightsManagement</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to set Information Rights Management (IRM) settings for.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Specifies whether Information Rights Management (IRM) is enabled for the list.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableExpiration</maml:name> <maml:description> <maml:para>Specifies whether Information Rights Management (IRM) expiration is enabled for the list.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableRejection</maml:name> <maml:description> <maml:para>Specifies whether Information Rights Management (IRM) rejection is enabled for the list.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowPrint</maml:name> <maml:description> <maml:para>Sets a value indicating whether the viewer can print the downloaded document.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowScript</maml:name> <maml:description> <maml:para>Sets a value indicating whether the viewer can run a script on the downloaded document.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowWriteCopy</maml:name> <maml:description> <maml:para>Sets a value indicating whether the viewer can write on a copy of the downloaded document.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableDocumentBrowserView</maml:name> <maml:description> <maml:para>Sets a value indicating whether to block Office Web Application Companion applications (WACs) from showing this document.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DocumentAccessExpireDays</maml:name> <maml:description> <maml:para>Sets the number of days after which the downloaded document will expire.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DocumentLibraryProtectionExpireDate</maml:name> <maml:description> <maml:para>Sets the date after which the Information Rights Management (IRM) protection of this document library will stop.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableDocumentAccessExpire</maml:name> <maml:description> <maml:para>Sets a value indicating whether the downloaded document will expire.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableDocumentBrowserPublishingView</maml:name> <maml:description> <maml:para>Sets a value indicating whether to enable Office Web Application Companion applications (WACs) to publishing view.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableGroupProtection</maml:name> <maml:description> <maml:para>Sets a value indicating whether the permission of the downloaded document is applicable to a group.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableLicenseCacheExpire</maml:name> <maml:description> <maml:para>Sets whether a user must verify their credentials after some interval.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LicenseCacheExpireDays</maml:name> <maml:description> <maml:para>Sets the number of days that the application that opens the document caches the IRM license. When these elapse, the application will connect to the IRM server to validate the license.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Sets the group name (email address) that the permission is also applicable to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PolicyDescription</maml:name> <maml:description> <maml:para>Sets the permission policy description.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PolicyTitle</maml:name> <maml:description> <maml:para>Sets the permission policy title.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AllowPrint</maml:name> <maml:description> <maml:para>Sets a value indicating whether the viewer can print the downloaded document.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowScript</maml:name> <maml:description> <maml:para>Sets a value indicating whether the viewer can run a script on the downloaded document.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowWriteCopy</maml:name> <maml:description> <maml:para>Sets a value indicating whether the viewer can write on a copy of the downloaded document.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableDocumentBrowserView</maml:name> <maml:description> <maml:para>Sets a value indicating whether to block Office Web Application Companion applications (WACs) from showing this document.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DocumentAccessExpireDays</maml:name> <maml:description> <maml:para>Sets the number of days after which the downloaded document will expire.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DocumentLibraryProtectionExpireDate</maml:name> <maml:description> <maml:para>Sets the date after which the Information Rights Management (IRM) protection of this document library will stop.</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Specifies whether Information Rights Management (IRM) is enabled for the list.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableDocumentAccessExpire</maml:name> <maml:description> <maml:para>Sets a value indicating whether the downloaded document will expire.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableDocumentBrowserPublishingView</maml:name> <maml:description> <maml:para>Sets a value indicating whether to enable Office Web Application Companion applications (WACs) to publishing view.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableExpiration</maml:name> <maml:description> <maml:para>Specifies whether Information Rights Management (IRM) expiration is enabled for the list.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableGroupProtection</maml:name> <maml:description> <maml:para>Sets a value indicating whether the permission of the downloaded document is applicable to a group.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableLicenseCacheExpire</maml:name> <maml:description> <maml:para>Sets whether a user must verify their credentials after some interval.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableRejection</maml:name> <maml:description> <maml:para>Specifies whether Information Rights Management (IRM) rejection is enabled for the list.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Sets the group name (email address) that the permission is also applicable to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LicenseCacheExpireDays</maml:name> <maml:description> <maml:para>Sets the number of days that the application that opens the document caches the IRM license. When these elapse, the application will connect to the IRM server to validate the license.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to set Information Rights Management (IRM) settings for.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PolicyDescription</maml:name> <maml:description> <maml:para>Sets the permission policy description.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PolicyTitle</maml:name> <maml:description> <maml:para>Sets the permission policy title.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPListInformationRightsManagement -List "Documents" -Enabled $true</dev:code> <maml:remarks> <maml:para>Enables Information Rights Management (IRM) on the list.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPListItem</command:name> <maml:description> <maml:para>Updates a list item</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPListItem</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPListItem</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specify either the name, ID or an actual content type</maml:para> </maml:description> <command:parameterValue required="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names. Single line of text: -Values @{"TextField" = "Title New"} Multiple lines of text: -Values @{"MultiTextField" = "New text\n\nMore text"} Rich text: -Values @{"MultiTextField" = "<strong>New</strong> text"} Choice: -Values @{"ChoiceField" = "Value 1"} Number: -Values @{"NumberField" = "10"} Currency: -Values @{"NumberField" = "10"} Currency: -Values @{"CurrencyField" = "10"} Date and Time: -Values @{"DateAndTimeField" = "03/13/2015 14:16"} Lookup (id of lookup value): -Values @{"LookupField" = "2"} Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} Yes/No: -Values @{"YesNoField" = $false} Person/Group (id of user/group in Site User Info List or email of the user, separate multiple values with a comma): -Values @{"PersonField" = "user1@domain.com","21"} Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = ("CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR")} Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = ("fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593")} Hyperlink or Picture: -Values @{"HyperlinkField" = "https://github.com/OfficeDev/, OfficePnp"}</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SystemUpdate</maml:name> <maml:description> <maml:para>Update the item without creating a new version.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The name of the retention label.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specify either the name, ID or an actual content type</maml:para> </maml:description> <command:parameterValue required="false">ContentTypePipeBind</command:parameterValue> <dev:type> <maml:name>ContentTypePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> <dev:type> <maml:name>ListItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The name of the retention label.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SystemUpdate</maml:name> <maml:description> <maml:para>Update the item without creating a new version.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names. Single line of text: -Values @{"TextField" = "Title New"} Multiple lines of text: -Values @{"MultiTextField" = "New text\n\nMore text"} Rich text: -Values @{"MultiTextField" = "<strong>New</strong> text"} Choice: -Values @{"ChoiceField" = "Value 1"} Number: -Values @{"NumberField" = "10"} Currency: -Values @{"NumberField" = "10"} Currency: -Values @{"CurrencyField" = "10"} Date and Time: -Values @{"DateAndTimeField" = "03/13/2015 14:16"} Lookup (id of lookup value): -Values @{"LookupField" = "2"} Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"} Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2} Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"} Yes/No: -Values @{"YesNoField" = $false} Person/Group (id of user/group in Site User Info List or email of the user, separate multiple values with a comma): -Values @{"PersonField" = "user1@domain.com","21"} Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = ("CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR")} Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = ("fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593")} Hyperlink or Picture: -Values @{"HyperlinkField" = "https://github.com/OfficeDev/, OfficePnp"}</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.ListItem</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-PnPListItem -List "Demo List" -Identity 1 -Values @{"Title" = "Test Title"; "Category"="Test Category"}</dev:code> <maml:remarks> <maml:para>Sets fields value in the list item with ID 1 in the "Demo List". It sets both the Title and Category fields with the specified values. Notice, use the internal names of fields.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-PnPListItem -List "Demo List" -Identity 1 -ContentType "Company" -Values @{"Title" = "Test Title"; "Category"="Test Category"}</dev:code> <maml:remarks> <maml:para>Sets fields value in the list item with ID 1 in the "Demo List". It sets the content type of the item to "Company" and it sets both the Title and Category fields with the specified values. Notice, use the internal names of fields.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-PnPListItem -List "Demo List" -Identity $item -Values @{"Title" = "Test Title"; "Category"="Test Category"}</dev:code> <maml:remarks> <maml:para>Sets fields value in the list item which has been retrieved by for instance Get-PnPListItem. It sets the content type of the item to "Company" and it sets both the Title and Category fields with the specified values. Notice, use the internal names of fields.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-PnPListItem -List "Demo List" -Identity 1 -Label "Public"</dev:code> <maml:remarks> <maml:para>Sets the retention label in the list item with ID 1 in the "Demo List".</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPListItemAsRecord</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Declares a list item as a record, for more information, see https://docs.microsoft.com/sharepoint/governance/records-management-in-sharepoint-server</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPListItemAsRecord</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPListItemAsRecord</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DeclarationDate</maml:name> <maml:description> <maml:para>The declaration date</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>DeclarationDate</maml:name> <maml:description> <maml:para>The declaration date</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> <dev:type> <maml:name>ListItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPListItemAsRecord -List "Documents" -Identity 4</dev:code> <maml:remarks> <maml:para>Declares the document in the documents library with id 4 as a record</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPListItemAsRecord -List "Documents" -Identity 4 -DeclarationDate $date</dev:code> <maml:remarks> <maml:para>Declares the document in the documents library with id as a record</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPListItemPermission</command:name> <maml:description> <maml:para>Sets list item permissions. Use Get-PnPRoleDefinition to retrieve all available roles you can add or remove using this cmdlet.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPListItemPermission</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPListItemPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InheritPermissions</maml:name> <maml:description> <maml:para>Inherit permissions from the list, removing unique permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SystemUpdate</maml:name> <maml:description> <maml:para>Update the item permissions without creating a new version or triggering MS Flow.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPListItemPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearExisting</maml:name> <maml:description> <maml:para>Clear all existing permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SystemUpdate</maml:name> <maml:description> <maml:para>Update the item permissions without creating a new version or triggering MS Flow.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPListItemPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearExisting</maml:name> <maml:description> <maml:para>Clear all existing permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SystemUpdate</maml:name> <maml:description> <maml:para>Update the item permissions without creating a new version or triggering MS Flow.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClearExisting</maml:name> <maml:description> <maml:para>Clear all existing permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> <dev:type> <maml:name>ListItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>InheritPermissions</maml:name> <maml:description> <maml:para>Inherit permissions from the list, removing unique permissions</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SystemUpdate</maml:name> <maml:description> <maml:para>Update the item permissions without creating a new version or triggering MS Flow.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPListItemPermission -List 'Documents' -Identity 1 -User 'user@contoso.com' -AddRole 'Contribute'</dev:code> <maml:remarks> <maml:para>Adds the 'Contribute' permission to the user 'user@contoso.com' for listitem with id 1 in the list 'Documents'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPListItemPermission -List 'Documents' -Identity 1 -User 'user@contoso.com' -RemoveRole 'Contribute'</dev:code> <maml:remarks> <maml:para>Removes the 'Contribute' permission to the user 'user@contoso.com' for listitem with id 1 in the list 'Documents'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPListItemPermission -List 'Documents' -Identity 1 -User 'user@contoso.com' -AddRole 'Contribute' -ClearExisting</dev:code> <maml:remarks> <maml:para>Adds the 'Contribute' permission to the user 'user@contoso.com' for listitem with id 1 in the list 'Documents' and removes all other permissions</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPListItemPermission -List 'Documents' -Identity 1 -InheritPermissions</dev:code> <maml:remarks> <maml:para>Resets permissions for listitem with id 1 to inherit permissions from the list 'Documents'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPListPermission</command:name> <maml:description> <maml:para>Sets list permissions</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPListPermission</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPListPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or Title of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPListPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or Title of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or Title of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPListPermission -Identity 'Documents' -User 'user@contoso.com' -AddRole 'Contribute'</dev:code> <maml:remarks> <maml:para>Adds the 'Contribute' permission to the user 'user@contoso.com' for the list 'Documents'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPListPermission -Identity 'Documents' -User 'user@contoso.com' -RemoveRole 'Contribute'</dev:code> <maml:remarks> <maml:para>Removes the 'Contribute' permission to the user 'user@contoso.com' for the list 'Documents'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPListRecordDeclaration</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. The RecordDeclaration parameter supports 4 values: AlwaysAllowManualDeclaration NeverAllowManualDeclaration UseSiteCollectionDefaults </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPListRecordDeclaration</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPListRecordDeclaration</maml:name> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The List to set the manual record declaration settings for</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ManualRecordDeclaration</maml:name> <maml:description> <maml:para>Defines the manual record declaration setting for the lists</maml:para> </maml:description> <command:parameterValue required="true">EcmListManualRecordDeclaration</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoRecordDeclaration</maml:name> <maml:description> <maml:para>Defines if you want to set auto record declaration on the list</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AutoRecordDeclaration</maml:name> <maml:description> <maml:para>Defines if you want to set auto record declaration on the list</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The List to set the manual record declaration settings for</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ManualRecordDeclaration</maml:name> <maml:description> <maml:para>Defines the manual record declaration setting for the lists</maml:para> </maml:description> <command:parameterValue required="false">EcmListManualRecordDeclaration</command:parameterValue> <dev:type> <maml:name>EcmListManualRecordDeclaration</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPListRecordDeclaration -List "Documents" -ManualRecordDeclaration NeverAllowManualDeclaration</dev:code> <maml:remarks> <maml:para>Sets the manual record declaration to never allow</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPListRecordDeclaration -List "Documents" -AutoRecordDeclaration $true</dev:code> <maml:remarks> <maml:para>Turns on auto record declaration for the list</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPMasterPage</command:name> <maml:description> <maml:para>Set the masterpage</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPMasterPage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets the default master page of the current web.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPMasterPage</maml:name> <command:parameter required="false" position="named"> <maml:name>MasterPageServerRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the Master page URL based on the server relative URL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomMasterPageServerRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the custom Master page URL based on the server relative URL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPMasterPage</maml:name> <command:parameter required="false" position="named"> <maml:name>MasterPageSiteRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the Master page URL based on the site relative URL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomMasterPageSiteRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the custom Master page URL based on the site relative URL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>CustomMasterPageServerRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the custom Master page URL based on the server relative URL</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomMasterPageSiteRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the custom Master page URL based on the site relative URL</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MasterPageServerRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the Master page URL based on the server relative URL</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MasterPageSiteRelativeUrl</maml:name> <maml:description> <maml:para>Specifies the Master page URL based on the site relative URL</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPMasterPage -MasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master</dev:code> <maml:remarks> <maml:para>Sets the master page based on a server relative URL</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPMasterPage -MasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master -CustomMasterPageServerRelativeUrl /sites/projects/_catalogs/masterpage/oslo.master</dev:code> <maml:remarks> <maml:para>Sets the master page and custom master page based on a server relative URL</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPMasterPage -MasterPageSiteRelativeUrl _catalogs/masterpage/oslo.master</dev:code> <maml:remarks> <maml:para>Sets the master page based on a site relative URL</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPMasterPage -MasterPageSiteRelativeUrl _catalogs/masterpage/oslo.master -CustomMasterPageSiteRelativeUrl _catalogs/masterpage/oslo.master</dev:code> <maml:remarks> <maml:para>Sets the master page and custom master page based on a site relative URL</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPMinimalDownloadStrategy</command:name> <maml:description> <maml:para>Activates or deactivates the minimal downloading strategy.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPMinimalDownloadStrategy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Activates or deactivates the minimal download strategy feature of a site</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPMinimalDownloadStrategy</maml:name> <command:parameter required="true" position="named"> <maml:name>On</maml:name> <maml:description> <maml:para>Turn minimal download strategy on</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifies whether to overwrite (when activating) or continue (when deactivating) an existing feature with the same feature identifier. This parameter is ignored if there are no errors.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPMinimalDownloadStrategy</maml:name> <command:parameter required="true" position="named"> <maml:name>Off</maml:name> <maml:description> <maml:para>Turn minimal download strategy off</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifies whether to overwrite (when activating) or continue (when deactivating) an existing feature with the same feature identifier. This parameter is ignored if there are no errors.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifies whether to overwrite (when activating) or continue (when deactivating) an existing feature with the same feature identifier. This parameter is ignored if there are no errors.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Off</maml:name> <maml:description> <maml:para>Turn minimal download strategy off</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>On</maml:name> <maml:description> <maml:para>Turn minimal download strategy on</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPMinimalDownloadStrategy -Off</dev:code> <maml:remarks> <maml:para>Will deactivate minimal download strategy (MDS) for the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPMinimalDownloadStrategy -On</dev:code> <maml:remarks> <maml:para>Will activate minimal download strategy (MDS) for the current web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPStorageEntity</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Set Storage Entities / Farm Properties in either the tenant scoped app catalog or the site collection app catalog.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPStorageEntity</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPStorageEntity</maml:name> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the value to set.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value to set.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>The comment to set.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description to set.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines the scope of the storage entity. Defaults to Tenant.</maml:para> </maml:description> <command:parameterValue required="true">StorageEntityScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>The comment to set.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description to set.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the value to set.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines the scope of the storage entity. Defaults to Tenant.</maml:para> </maml:description> <command:parameterValue required="false">StorageEntityScope</command:parameterValue> <dev:type> <maml:name>StorageEntityScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value to set.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPStorageEntity -Key MyKey -Value "MyValue" -Comment "My Comment" -Description "My Description"</dev:code> <maml:remarks> <maml:para>Sets an existing or adds a new storage entity / farm property at tenant level.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPStorageEntity -Scope Site -Key MyKey -Value "MyValue" -Comment "My Comment" -Description "My Description"</dev:code> <maml:remarks> <maml:para>Sets an existing or adds a new storage entity site collection level.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPPropertyBagValue</command:name> <maml:description> <maml:para>Sets a property bag value</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPPropertyBagValue</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPPropertyBagValue</maml:name> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site relative url of the folder. See examples for use.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPPropertyBagValue</maml:name> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Indexed</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Site relative url of the folder. See examples for use.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Indexed</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPPropertyBagValue -Key MyKey -Value MyValue</dev:code> <maml:remarks> <maml:para>This sets or adds a value to the current web property bag</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPPropertyBagValue -Key MyKey -Value MyValue -Folder /</dev:code> <maml:remarks> <maml:para>This sets or adds a value to the root folder of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPPropertyBagValue -Key MyKey -Value MyValue -Folder /MyFolder</dev:code> <maml:remarks> <maml:para>This sets or adds a value to the folder MyFolder which is located in the root folder of the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPProvisioningTemplateMetadata</command:name> <maml:description> <maml:para>Sets metadata of a provisioning template</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPProvisioningTemplateMetadata</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPProvisioningTemplateMetadata</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml or pnp file containing the site template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateDisplayName</maml:name> <maml:description> <maml:para>It can be used to specify the DisplayName of the template file that will be updated.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateImagePreviewUrl</maml:name> <maml:description> <maml:para>It can be used to specify the ImagePreviewUrl of the template file that will be updated.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProperties</maml:name> <maml:description> <maml:para>It can be used to specify custom Properties for the template file that will be updated.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while extracting a template.</maml:para> </maml:description> <command:parameterValue required="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the xml or pnp file containing the site template.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateDisplayName</maml:name> <maml:description> <maml:para>It can be used to specify the DisplayName of the template file that will be updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateImagePreviewUrl</maml:name> <maml:description> <maml:para>It can be used to specify the ImagePreviewUrl of the template file that will be updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProperties</maml:name> <maml:description> <maml:para>It can be used to specify custom Properties for the template file that will be updated.</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TemplateProviderExtensions</maml:name> <maml:description> <maml:para>Allows you to specify ITemplateProviderExtension to execute while extracting a template.</maml:para> </maml:description> <command:parameterValue required="false">ITemplateProviderExtension[]</command:parameterValue> <dev:type> <maml:name>ITemplateProviderExtension[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPProvisioningTemplateMetadata -Path template.xml -TemplateDisplayName "DisplayNameValue"</dev:code> <maml:remarks> <maml:para>Sets the DisplayName property of a site template in XML format.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPProvisioningTemplateMetadata -Path template.pnp -TemplateDisplayName "DisplayNameValue"</dev:code> <maml:remarks> <maml:para>Sets the DisplayName property of a site template in Office Open XML format.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPProvisioningTemplateMetadata -Path template.xml -TemplateImagePreviewUrl "Full URL of the Image Preview"</dev:code> <maml:remarks> <maml:para>Sets the Url to the preview image of a site template in XML format.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPProvisioningTemplateMetadata -Path template.pnp -TemplateImagePreviewUrl "Full URL of the Image Preview"</dev:code> <maml:remarks> <maml:para>Sets the to the preview image of a site template in Office Open XML format.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPProvisioningTemplateMetadata -Path template.xml -TemplateProperties @{"Property1" = "Test Value 1"; "Property2"="Test Value 2"}</dev:code> <maml:remarks> <maml:para>Sets the property 'Property1' to the value 'Test Value 1' of a site template in XML format.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPProvisioningTemplateMetadata -Path template.pnp -TemplateProperties @{"Property1" = "Test Value 1"; "Property2"="Test Value 2"}</dev:code> <maml:remarks> <maml:para>Sets the property 'Property1' to the value 'Test Value 1' of a site template in Office Open XML format.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPRequestAccessEmails</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Sets Request Access Email on a web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPRequestAccessEmails</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Enables or disables access requests to be sent and configures which e-mail address should receive these requests. The web you apply this on must have unique rights.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPRequestAccessEmails</maml:name> <command:parameter required="false" position="named"> <maml:name>Emails</maml:name> <maml:description> <maml:para>Email address to send the access requests to</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Enables or disables access to be requested</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Enables or disables access to be requested</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Emails</maml:name> <maml:description> <maml:para>Email address to send the access requests to</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPRequestAccessEmails -Emails someone@example.com </dev:code> <maml:remarks> <maml:para>This will enable requesting access and send the requests to the provided e-mail address</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPRequestAccessEmails -Disabled</dev:code> <maml:remarks> <maml:para>This will disable the ability to request access to the site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPRequestAccessEmails -Disabled:$false</dev:code> <maml:remarks> <maml:para>This will enable the ability to request access to the site and send the requests to the default owners of the site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPSearchConfiguration</command:name> <maml:description> <maml:para>Sets the search configuration</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPSearchConfiguration</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPSearchConfiguration</maml:name> <command:parameter required="true" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Search configuration string</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SearchConfigurationScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPSearchConfiguration</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to a search configuration</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SearchConfigurationScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Search configuration string</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to a search configuration</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SearchConfigurationScope</command:parameterValue> <dev:type> <maml:name>SearchConfigurationScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSearchConfiguration -Configuration $config</dev:code> <maml:remarks> <maml:para>Sets the search configuration for the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSearchConfiguration -Configuration $config -Scope Site</dev:code> <maml:remarks> <maml:para>Sets the search configuration for the current site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSearchConfiguration -Configuration $config -Scope Subscription</dev:code> <maml:remarks> <maml:para>Sets the search configuration for the current tenant</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSearchConfiguration -Path searchconfig.xml -Scope Subscription</dev:code> <maml:remarks> <maml:para>Reads the search configuration from the specified XML file and sets it for the current tenant</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPSearchSettings</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Sets search settings for a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPSearchSettings</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPSearchSettings</maml:name> <command:parameter required="false" position="named"> <maml:name>SearchBoxInNavBar</maml:name> <maml:description> <maml:para>Set the scope of which the suite bar search box shows. Possible values: Inherit, AllPages, ModernOnly, Hidden</maml:para> </maml:description> <command:parameterValue required="true">SearchBoxInNavBarType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchPageUrl</maml:name> <maml:description> <maml:para>Set the URL where the search box should redirect to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchScope</maml:name> <maml:description> <maml:para>Set the search scope of the suite bar search box. Possible values: DefaultScope, Tenant, Hub, Site</maml:para> </maml:description> <command:parameterValue required="true">SearchScopeType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope to apply the setting to. Possible values: Web (default), Site\r\n\r\nFor a root site, the scope does not matter.</maml:para> </maml:description> <command:parameterValue required="true">SearchSettingsScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope to apply the setting to. Possible values: Web (default), Site\r\n\r\nFor a root site, the scope does not matter.</maml:para> </maml:description> <command:parameterValue required="false">SearchSettingsScope</command:parameterValue> <dev:type> <maml:name>SearchSettingsScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchBoxInNavBar</maml:name> <maml:description> <maml:para>Set the scope of which the suite bar search box shows. Possible values: Inherit, AllPages, ModernOnly, Hidden</maml:para> </maml:description> <command:parameterValue required="false">SearchBoxInNavBarType</command:parameterValue> <dev:type> <maml:name>SearchBoxInNavBarType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchPageUrl</maml:name> <maml:description> <maml:para>Set the URL where the search box should redirect to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchScope</maml:name> <maml:description> <maml:para>Set the search scope of the suite bar search box. Possible values: DefaultScope, Tenant, Hub, Site</maml:para> </maml:description> <command:parameterValue required="false">SearchScopeType</command:parameterValue> <dev:type> <maml:name>SearchScopeType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSearchSettings -SearchBoxInNavBar Hidden -Scope Site</dev:code> <maml:remarks> <maml:para>Hide the suite bar search box on all pages and sites in the site collection</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSearchSettings -SearchBoxInNavBar Hidden -Scope Web</dev:code> <maml:remarks> <maml:para>Hide the suite bar search box on all pages in the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSearchSettings -SearchPageUrl "https://contoso.sharepoint.com/sites/mysearch/SitePages/search.aspx"</dev:code> <maml:remarks> <maml:para>Redirect the suite bar search box in the site to a custom URL</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSearchSettings -SearchPageUrl ""</dev:code> <maml:remarks> <maml:para>Clear the suite bar search box URL and revert to the default behavior</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSearchSettings -SearchPageUrl "https://contoso.sharepoint.com/sites/mysearch/SitePages/search.aspx" -Scope Site</dev:code> <maml:remarks> <maml:para>Redirect classic search to a custom URL</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 6---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSearchSettings -SearchScope Tenant</dev:code> <maml:remarks> <maml:para>Set default behavior of the suite bar search box to show tenant wide results instead of site or hub scoped results</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 7---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSearchSettings -SearchScope Hub</dev:code> <maml:remarks> <maml:para>Set default behavior of the suite bar search box to show hub results instead of site results on an associated hub site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Sets Site Collection properties.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPSite</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPSite</maml:name> <command:parameter required="false" position="named"> <maml:name>Classification</maml:name> <maml:description> <maml:para>The classification to set</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableFlows</maml:name> <maml:description> <maml:para>Disables Microsoft Flow for this site</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogoFilePath</maml:name> <maml:description> <maml:para>Sets the logo of the site if it concerns a modern team site. Provide a full path to a local image file on your disk which you want to use as the site logo. The logo will be uploaded automatically to SharePoint. If you want to set the logo for a classic site, use Set-PnPWeb -SiteLogoUrl.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sharing</maml:name> <maml:description> <maml:para>Specifies what the sharing capabilities are for the site. Possible values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly</maml:para> </maml:description> <command:parameterValue required="true">SharingCapabilities</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageMaximumLevel</maml:name> <maml:description> <maml:para>Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageWarningLevel</maml:name> <maml:description> <maml:para>Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageMaximumLevel parameter</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowSelfServiceUpgrade</maml:name> <maml:description> <maml:para>Specifies if the site administrator can upgrade the site collection</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoScriptSite</maml:name> <maml:description> <maml:para>Specifies if a site allows custom script or not. See https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f for more information.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies owner(s) to add as site collection administrators. They will be added as additional site collection administrators. Existing administrators will stay. Can be both users and groups.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CommentsOnSitePagesDisabled</maml:name> <maml:description> <maml:para>Specifies if comments on site pages are enabled or disabled</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultLinkPermission</maml:name> <maml:description> <maml:para>Specifies the default link permission for the site collection. None - Respect the organization default link permission. View - Sets the default link permission for the site to "view" permissions. Edit - Sets the default link permission for the site to "edit" permissions</maml:para> </maml:description> <command:parameterValue required="true">SharingPermissionType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultSharingLinkType</maml:name> <maml:description> <maml:para>Specifies the default link type for the site collection. None - Respect the organization default sharing link type. AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link. Internal - Sets the default sharing link for this site to the "organization" link or company shareable link. Direct - Sets the default sharing link for this site to the "Specific people" link</maml:para> </maml:description> <command:parameterValue required="true">SharingLinkType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableAppViews</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">AppViewsPolicy</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableCompanyWideSharingLinks</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">CompanyWideSharingLinksPolicy</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableSharingForNonOwners</maml:name> <maml:description> <maml:para>Specifies to prevent non-owners from inviting new users to the site</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LocaleId</maml:name> <maml:description> <maml:para>Specifies the language of this site collection.</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RestrictedToGeo</maml:name> <maml:description> <maml:para>Specifies the Geo/Region restrictions of this site.</maml:para> </maml:description> <command:parameterValue required="true">RestrictedToRegion</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SocialBarOnSitePagesDisabled</maml:name> <maml:description> <maml:para>Disables or enables the Social Bar for Site Collection.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPSite</maml:name> <command:parameter required="false" position="named"> <maml:name>LockState</maml:name> <maml:description> <maml:para>Sets the lockstate of a site</maml:para> </maml:description> <command:parameterValue required="true">SiteLockState</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for the operation to complete</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AllowSelfServiceUpgrade</maml:name> <maml:description> <maml:para>Specifies if the site administrator can upgrade the site collection</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Classification</maml:name> <maml:description> <maml:para>The classification to set</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CommentsOnSitePagesDisabled</maml:name> <maml:description> <maml:para>Specifies if comments on site pages are enabled or disabled</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultLinkPermission</maml:name> <maml:description> <maml:para>Specifies the default link permission for the site collection. None - Respect the organization default link permission. View - Sets the default link permission for the site to "view" permissions. Edit - Sets the default link permission for the site to "edit" permissions</maml:para> </maml:description> <command:parameterValue required="false">SharingPermissionType</command:parameterValue> <dev:type> <maml:name>SharingPermissionType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultSharingLinkType</maml:name> <maml:description> <maml:para>Specifies the default link type for the site collection. None - Respect the organization default sharing link type. AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link. Internal - Sets the default sharing link for this site to the "organization" link or company shareable link. Direct - Sets the default sharing link for this site to the "Specific people" link</maml:para> </maml:description> <command:parameterValue required="false">SharingLinkType</command:parameterValue> <dev:type> <maml:name>SharingLinkType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableAppViews</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">AppViewsPolicy</command:parameterValue> <dev:type> <maml:name>AppViewsPolicy</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableCompanyWideSharingLinks</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">CompanyWideSharingLinksPolicy</command:parameterValue> <dev:type> <maml:name>CompanyWideSharingLinksPolicy</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableFlows</maml:name> <maml:description> <maml:para>Disables Microsoft Flow for this site</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableSharingForNonOwners</maml:name> <maml:description> <maml:para>Specifies to prevent non-owners from inviting new users to the site</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LocaleId</maml:name> <maml:description> <maml:para>Specifies the language of this site collection.</maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LockState</maml:name> <maml:description> <maml:para>Sets the lockstate of a site</maml:para> </maml:description> <command:parameterValue required="false">SiteLockState</command:parameterValue> <dev:type> <maml:name>SiteLockState</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogoFilePath</maml:name> <maml:description> <maml:para>Sets the logo of the site if it concerns a modern team site. Provide a full path to a local image file on your disk which you want to use as the site logo. The logo will be uploaded automatically to SharePoint. If you want to set the logo for a classic site, use Set-PnPWeb -SiteLogoUrl.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoScriptSite</maml:name> <maml:description> <maml:para>Specifies if a site allows custom script or not. See https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f for more information.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies owner(s) to add as site collection administrators. They will be added as additional site collection administrators. Existing administrators will stay. Can be both users and groups.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RestrictedToGeo</maml:name> <maml:description> <maml:para>Specifies the Geo/Region restrictions of this site.</maml:para> </maml:description> <command:parameterValue required="false">RestrictedToRegion</command:parameterValue> <dev:type> <maml:name>RestrictedToRegion</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Sharing</maml:name> <maml:description> <maml:para>Specifies what the sharing capabilities are for the site. Possible values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly</maml:para> </maml:description> <command:parameterValue required="false">SharingCapabilities</command:parameterValue> <dev:type> <maml:name>SharingCapabilities</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SocialBarOnSitePagesDisabled</maml:name> <maml:description> <maml:para>Disables or enables the Social Bar for Site Collection.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageMaximumLevel</maml:name> <maml:description> <maml:para>Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageWarningLevel</maml:name> <maml:description> <maml:para>Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageMaximumLevel parameter</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for the operation to complete</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSite -Classification "HBI"</dev:code> <maml:remarks> <maml:para>Sets the current site classification to HBI</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSite -Classification $null</dev:code> <maml:remarks> <maml:para>Unsets the current site classification</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSite -DisableFlows</dev:code> <maml:remarks> <maml:para>Disables Microsoft Flow for this site, and also hides the Flow button from the ribbon</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSite -DisableFlows:$false</dev:code> <maml:remarks> <maml:para>Enables Microsoft Flow for this site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSite -LogoFilePath c:\images\mylogo.png</dev:code> <maml:remarks> <maml:para>Sets the logo if the site is a modern team site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPSiteClosure</command:name> <maml:description> <maml:para>Opens or closes a site which has a site policy applied</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPSiteClosure</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPSiteClosure</maml:name> <command:parameter required="true" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>The state of the site</maml:para> </maml:description> <command:parameterValue required="true">ClosureState</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>The state of the site</maml:para> </maml:description> <command:parameterValue required="true">ClosureState</command:parameterValue> <dev:type> <maml:name>ClosureState</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSiteClosure -State Open</dev:code> <maml:remarks> <maml:para>This opens a site which has been closed and has a site policy applied.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSiteClosure -State Closed</dev:code> <maml:remarks> <maml:para>This closes a site which is open and has a site policy applied.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPSiteDesign</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Updates a Site Design on the current tenant.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPSiteDesign</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPSiteDesign</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The guid or an object representing the site design</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site design</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SiteScriptIds</maml:name> <maml:description> <maml:para>An array of guids of site scripts</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site design</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Specifies if the site design is a default site design</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PreviewImageAltText</maml:name> <maml:description> <maml:para>Sets the text for the preview image</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PreviewImageUrl</maml:name> <maml:description> <maml:para>Sets the url to the preview image</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebTemplate</maml:name> <maml:description> <maml:para>Specifies the type of site to which this design applies</maml:para> </maml:description> <command:parameterValue required="true">SiteWebTemplate</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version of the design</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site design</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The guid or an object representing the site design</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteDesignPipeBind</command:parameterValue> <dev:type> <maml:name>TenantSiteDesignPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Specifies if the site design is a default site design</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PreviewImageAltText</maml:name> <maml:description> <maml:para>Sets the text for the preview image</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PreviewImageUrl</maml:name> <maml:description> <maml:para>Sets the url to the preview image</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SiteScriptIds</maml:name> <maml:description> <maml:para>An array of guids of site scripts</maml:para> </maml:description> <command:parameterValue required="false">GuidPipeBind[]</command:parameterValue> <dev:type> <maml:name>GuidPipeBind[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site design</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version of the design</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebTemplate</maml:name> <maml:description> <maml:para>Specifies the type of site to which this design applies</maml:para> </maml:description> <command:parameterValue required="false">SiteWebTemplate</command:parameterValue> <dev:type> <maml:name>SiteWebTemplate</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSiteDesign -Identity 046e2e76-67ba-46ca-a5f6-8eb418a7821e -Title "My Updated Company Design"</dev:code> <maml:remarks> <maml:para>Updates an existing Site Design and sets a new title.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $design = Get-PnPSiteDesign -Identity 046e2e76-67ba-46ca-a5f6-8eb418a7821e PS:> Set-PnPSiteDesign -Identity $design -Title "My Updated Company Design"</dev:code> <maml:remarks> <maml:para>Updates an existing Site Design and sets a new title.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPSiteScript</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Updates an existing Site Script on the current tenant.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPSiteScript</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPSiteScript</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The guid or an object representing the site script</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteScriptPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site script</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site script</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para>A JSON string containing the site script</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version of the site script</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para>A JSON string containing the site script</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site script</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The guid or an object representing the site script</maml:para> </maml:description> <command:parameterValue required="true">TenantSiteScriptPipeBind</command:parameterValue> <dev:type> <maml:name>TenantSiteScriptPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site script</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version of the site script</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPSiteScript -Identity f1d55d9b-b116-4f54-bc00-164a51e7e47f -Title "My Site Script"</dev:code> <maml:remarks> <maml:para>Updates an existing Site Script and changes the title.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $script = Get-PnPSiteScript -Identity f1d55d9b-b116-4f54-bc00-164a51e7e47f PS:> Set-PnPSiteScript -Identity $script -Title "My Site Script"</dev:code> <maml:remarks> <maml:para>Updates an existing Site Script and changes the title.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPTaxonomyFieldValue</command:name> <maml:description> <maml:para>Sets a taxonomy term value in a listitem field</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPTaxonomyFieldValue</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPTaxonomyFieldValue</maml:name> <command:parameter required="true" position="named"> <maml:name>ListItem</maml:name> <maml:description> <maml:para>The list item to set the field value to</maml:para> </maml:description> <command:parameterValue required="true">ListItem</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalFieldName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Terms</maml:name> <maml:description> <maml:para>Allows you to specify terms with key value pairs that can be referred to in the template by means of the {id:label} token. See examples on how to use this parameter.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPTaxonomyFieldValue</maml:name> <command:parameter required="true" position="named"> <maml:name>TermId</maml:name> <maml:description> <maml:para>The Id of the Term</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ListItem</maml:name> <maml:description> <maml:para>The list item to set the field value to</maml:para> </maml:description> <command:parameterValue required="true">ListItem</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalFieldName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The Label value of the term</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPTaxonomyFieldValue</maml:name> <command:parameter required="true" position="named"> <maml:name>TermPath</maml:name> <maml:description> <maml:para>A path in the form of GROUPLABEL|TERMSETLABEL|TERMLABEL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ListItem</maml:name> <maml:description> <maml:para>The list item to set the field value to</maml:para> </maml:description> <command:parameterValue required="true">ListItem</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>InternalFieldName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>InternalFieldName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The Label value of the term</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ListItem</maml:name> <maml:description> <maml:para>The list item to set the field value to</maml:para> </maml:description> <command:parameterValue required="true">ListItem</command:parameterValue> <dev:type> <maml:name>ListItem</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermId</maml:name> <maml:description> <maml:para>The Id of the Term</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>TermPath</maml:name> <maml:description> <maml:para>A path in the form of GROUPLABEL|TERMSETLABEL|TERMLABEL</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Terms</maml:name> <maml:description> <maml:para>Allows you to specify terms with key value pairs that can be referred to in the template by means of the {id:label} token. See examples on how to use this parameter.</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTaxonomyFieldValue -ListItem $item -InternalFieldName 'Department' -TermId 863b832b-6818-4e6a-966d-2d3ee057931c</dev:code> <maml:remarks> <maml:para>Sets the field called 'Department' to the value of the term with the ID specified</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTaxonomyFieldValue -ListItem $item -InternalFieldName 'Department' -TermPath 'CORPORATE|DEPARTMENTS|HR'</dev:code> <maml:remarks> <maml:para>Sets the field called 'Department' to the term called HR which is located in the DEPARTMENTS termset, which in turn is located in the CORPORATE termgroup.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTaxonomyFieldValue -ListItem $item -InternalFieldName 'Department' -Terms @{"TermId1"="Label1";"TermId2"="Label2"}</dev:code> <maml:remarks> <maml:para>Sets the field called 'Department' with multiple terms by ID and label. You can refer to those terms with the {ID:label} token.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPTenant</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Sets organization-level site collection properties</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPTenant</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets organization-level site collection properties such as StorageQuota, StorageQuotaAllocated, ResourceQuota, ResourceQuotaAllocated, and SiteCreationMode. You must be a SharePoint Online global administrator to run the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPTenant</maml:name> <command:parameter required="false" position="named"> <maml:name>MinCompatibilityLevel</maml:name> <maml:description> <maml:para>Specifies the lower bound on the compatibility level for new sites.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MaxCompatibilityLevel</maml:name> <maml:description> <maml:para>Specifies the upper bound on the compatibility level for new sites.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExternalServicesEnabled</maml:name> <maml:description> <maml:para>Enables external services for a tenant. External services are defined as services that are not in the Office 365 datacenters. The valid values are: True (default) - External services are enabled for the tenant. False - External services that are outside of the Office 365 datacenters cannot interact with SharePoint.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoAccessRedirectUrl</maml:name> <maml:description> <maml:para>Specifies the URL of the redirected site for those site collections which have the locked state "NoAccess" The valid values are: ""(default) - Blank by default, this will also remove or clear any value that has been set. Full URL - Example: https://contoso.sharepoint.com/Pages/Locked.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingCapability</maml:name> <maml:description> <maml:para>Determines what level of sharing is available for the site. The valid values are: ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled. Disabled - External user sharing (share by email) and guest link sharing are both disabled. ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing is disabled. For more information about sharing, see Manage external sharing for your SharePoint online environment (http://office.microsoft.com/en-us/office365-sharepoint-online-enterprise-help/manage-external-sharing-for-your-sharepoint-online-environment-HA102849864.aspx).</maml:para> </maml:description> <command:parameterValue required="true">SharingCapabilities</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayStartASiteOption</maml:name> <maml:description> <maml:para>Determines whether tenant users see the Start a Site menu option. The valid values are: True (default) - Tenant users will see the Start a Site menu option. False - Start a Site is hidden from the menu.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartASiteFormUrl</maml:name> <maml:description> <maml:para>Specifies URL of the form to load in the Start a Site dialog. The valid values are: "" (default) - Blank by default, this will also remove or clear any value that has been set. Full URL - Example: "https://contoso.sharepoint.com/path/to/form"</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShowEveryoneClaim</maml:name> <maml:description> <maml:para>Enables the administrator to hide the Everyone claim in the People Picker. When users share an item with Everyone, it is accessible to all authenticated users in the tenant's Azure Active Directory, including any active external users who have previously accepted invitations. Note, that some SharePoint system resources such as templates and pages are required to be shared to Everyone and this type of sharing does not expose any user data or metadata. The valid values are: True (default) - The Everyone claim group is displayed in People Picker. False - The Everyone claim group is hidden from the People Picker.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShowAllUsersClaim</maml:name> <maml:description> <maml:para>Enables the administrator to hide the All Users claim groups in People Picker. When users share an item with "All Users (x)", it is accessible to all organization members in the tenant's Azure Active Directory who have authenticated with via this method. When users share an item with "All Users (x)" it is accessible to all organization members in the tenant that used NTLM to authentication with SharePoint. Note, the All Users(authenticated) group is equivalent to the Everyone claim, and shows as Everyone.To change this, see - ShowEveryoneClaim. The valid values are: True(default) - The All Users claim groups are displayed in People Picker. False - The All Users claim groups are hidden in People Picker.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShowEveryoneExceptExternalUsersClaim</maml:name> <maml:description> <maml:para>Enables the administrator to hide the "Everyone except external users" claim in the People Picker. When users share an item with "Everyone except external users", it is accessible to all organization members in the tenant's Azure Active Directory, but not to any users who have previously accepted invitations. The valid values are: True(default) - The Everyone except external users is displayed in People Picker. False - The Everyone except external users claim is not visible in People Picker.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchResolveExactEmailOrUPN</maml:name> <maml:description> <maml:para>Removes the search capability from People Picker. Note, recently resolved names will still appear in the list until browser cache is cleared or expired. SharePoint Administrators will still be able to use starts with or partial name matching when enabled. The valid values are: False (default) - Starts with / partial name search functionality is available. True - Disables starts with / partial name search functionality for all SharePoint users, except SharePoint Admins.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OfficeClientADALDisabled</maml:name> <maml:description> <maml:para>When set to true this will disable the ability to use Modern Authentication that leverages ADAL across the tenant. The valid values are: False (default) - Modern Authentication is enabled/allowed. True - Modern Authentication via ADAL is disabled.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LegacyAuthProtocolsEnabled</maml:name> <maml:description> <maml:para>By default this value is set to $true. Setting this parameter prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. A value of $true - Enables Office clients using non-modern authentication protocols(such as, Forms-Based Authentication (FBA) or Identity Client Runtime Library (IDCRL)) to access SharePoint resources. A value of $false - Prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. Note: This may also prevent third-party apps from accessing SharePoint Online resources.Also, this will also block apps using the SharePointOnlineCredentials class to access SharePoint Online resources.For additional information about SharePointOnlineCredentials, see SharePointOnlineCredentials class.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequireAcceptingAccountMatchInvitedAccount</maml:name> <maml:description> <maml:para>Ensures that an external user can only accept an external sharing invitation with an account matching the invited email address. Administrators who desire increased control over external collaborators should consider enabling this feature. Note, this only applies to new external users accepting new sharing invitations. Also, the resource owner must share with an organizational or Microsoft account or the external user will be unable to access the resource. The valid values are: False (default) - When a document is shared with an external user, bob@contoso.com, it can be accepted by any user with access to the invitation link in the original e-mail. True - User must accept this invitation with bob@contoso.com.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionSharedWithEveryoneFolder</maml:name> <maml:description> <maml:para>Creates a Shared with Everyone folder in every user's new OneDrive for Business document library. The valid values are: True (default) - The Shared with Everyone folder is created. False - No folder is created when the site and OneDrive for Business document library is created. The default behavior of the Shared with Everyone folder changed in August 2015. For additional information about the change, see Provision the Shared with Everyone folder in OneDrive for Business (https://support.office.com/en-us/article/Provision-the-Shared-with-Everyone-folder-in-OneDrive-for-Business-6bb02c91-fd0b-42ba-9457-3921cb6dc5b2?ui=en-US&rs=en-US&ad=US)</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SignInAccelerationDomain</maml:name> <maml:description> <maml:para>Specifies the home realm discovery value to be sent to Azure Active Directory (AAD) during the user sign-in process. When the organization uses a third-party identity provider, this prevents the user from seeing the Azure Active Directory Home Realm Discovery web page and ensures the user only sees their company's Identity Provider's portal. This value can also be used with Azure Active Directory Premium to customize the Azure Active Directory login page. Acceleration will not occur on site collections that are shared externally. This value should be configured with the login domain that is used by your company (that is, example@contoso.com). If your company has multiple third-party identity providers, configuring the sign-in acceleration value will break sign-in for your organization. The valid values are: "" (default) - Blank by default, this will also remove or clear any value that has been set. Login Domain - For example: "contoso.com"</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableGuestSignInAcceleration</maml:name> <maml:description> <maml:para>Accelerates guest-enabled site collections as well as member-only site collections when the SignInAccelerationDomain parameter is set. Note: If enabled, your identity provider must be capable of authenticating guest users. If it is not, guest users will be unable to log in and access content that was shared with them.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsePersistentCookiesForExplorerView</maml:name> <maml:description> <maml:para>Lets SharePoint issue a special cookie that will allow this feature to work even when "Keep Me Signed In" is not selected. "Open with Explorer" requires persisted cookies to operate correctly. When the user does not select "Keep Me Signed in" at the time of sign -in, "Open with Explorer" will fail. This special cookie expires after 30 minutes and cannot be cleared by closing the browser or signing out of SharePoint Online.To clear this cookie, the user must log out of their Windows session. The valid values are: False(default) - No special cookie is generated and the normal Office 365 sign -in length / timing applies. True - Generates a special cookie that will allow "Open with Explorer" to function if the "Keep Me Signed In" box is not checked at sign -in.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BccExternalSharingInvitations</maml:name> <maml:description> <maml:para>When the feature is enabled, all external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingInvitationsList. The valid values are: False (default) - BCC for external sharing is disabled. True - All external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingInvitationsList.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BccExternalSharingInvitationsList</maml:name> <maml:description> <maml:para>Specifies a list of e-mail addresses to be BCC'd when the BCC for External Sharing feature is enabled. Multiple addresses can be specified by creating a comma separated list with no spaces. The valid values are: "" (default) - Blank by default, this will also clear any value that has been set. Single or Multiple e-mail addresses - joe@contoso.com or joe@contoso.com,bob@contoso.com</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserVoiceForFeedbackEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublicCdnEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublicCdnAllowedFileTypes</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequireAnonymousLinksExpireInDays</maml:name> <maml:description> <maml:para>Specifies all anonymous links that have been created (or will be created) will expire after the set number of days . To remove the expiration requirement, set the value to zero (0).</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingAllowedDomainList</maml:name> <maml:description> <maml:para>Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingBlockedDomainList</maml:name> <maml:description> <maml:para>Specifies a list of email domains that is blocked or prohibited for sharing with the external collaborators. Use space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingDomainRestrictionMode</maml:name> <maml:description> <maml:para>Specifies the external sharing mode for domains. The following values are: None AllowList BlockList For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business.</maml:para> </maml:description> <command:parameterValue required="true">SharingDomainRestrictionModes</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OneDriveStorageQuota</maml:name> <maml:description> <maml:para>Sets a default OneDrive for Business storage quota for the tenant. It will be used for new OneDrive for Business sites created. A typical use will be to reduce the amount of storage associated with OneDrive for Business to a level below what the License entitles the users. For example, it could be used to set the quota to 10 gigabytes (GB) by default. If value is set to 0, the parameter will have no effect. If the value is set larger than the Maximum allowed OneDrive for Business quota, it will have no effect.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OneDriveForGuestsEnabled</maml:name> <maml:description> <maml:para>Lets OneDrive for Business creation for administrator managed guest users. Administrator managed Guest users use credentials in the resource tenant to access the resources. The valid values are the following: $true-Administrator managed Guest users can be given OneDrives, provided needed licenses are assigned. $false- Administrator managed Guest users can't be given OneDrives as functionality is turned off.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IPAddressEnforcement</maml:name> <maml:description> <maml:para>Allows access from network locations that are defined by an administrator. The values are $true and $false. The default value is $false which means the setting is disabled. Before the IPAddressEnforcement parameter is set, make sure you add a valid IPv4 or IPv6 address to the IPAddressAllowList parameter.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IPAddressAllowList</maml:name> <maml:description> <maml:para>Configures multiple IP addresses or IP address ranges (IPv4 or IPv6). Use commas to separate multiple IP addresses or IP address ranges. Verify there are no overlapping IP addresses and ensure IP ranges use Classless Inter-Domain Routing (CIDR) notation. For example, 172.16.0.0, 192.168.1.0/27. Note: The IPAddressAllowList parameter only lets administrators set IP addresses or ranges that are recognized as trusted. To only grant access from these IP addresses or ranges, set the IPAddressEnforcement parameter to $true.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IPAddressWACTokenLifetime</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseFindPeopleInPeoplePicker</maml:name> <maml:description> <maml:para>Note: When set to $true, users aren't able to share with security groups or SharePoint groups.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultSharingLinkType</maml:name> <maml:description> <maml:para>Lets administrators choose what type of link appears is selected in the “Get a link” sharing dialog box in OneDrive for Business and SharePoint Online. For additional information about how to change the default link type, see Change the default link type when users get links for sharing. Note: Setting this value to “none” will default “get a link” to the most permissive link available (that is, if anonymous links are enabled, the default link will be anonymous access; if they are disabled then the default link will be internal. The values are: None Direct Internal AnonymousAccess</maml:para> </maml:description> <command:parameterValue required="true">SharingLinkType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ODBMembersCanShare</maml:name> <maml:description> <maml:para>Lets administrators set policy on re-sharing behavior in OneDrive for Business. Values: On- Users with edit permissions can re-share. Off- Only OneDrive for Business owner can share. The value of ODBAccessRequests defines whether a request to share gets sent to the owner. Unspecified- Let each OneDrive for Business owner enable or disable re-sharing behavior on their OneDrive.</maml:para> </maml:description> <command:parameterValue required="true">SharingState</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ODBAccessRequests</maml:name> <maml:description> <maml:para>Lets administrators set policy on access requests and requests to share in OneDrive for Business. Values: On- Users without permission to share can trigger sharing requests to the OneDrive for Business owner when they attempt to share. Also, users without permission to a file or folder can trigger access requests to the OneDrive for Business owner when they attempt to access an item they do not have permissions to. Off- Prevent access requests and requests to share on OneDrive for Business. Unspecified- Let each OneDrive for Business owner enable or disable access requests and requests to share on their OneDrive.</maml:para> </maml:description> <command:parameterValue required="true">SharingState</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PreventExternalUsersFromResharing</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShowPeoplePickerSuggestionsForGuestUsers</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FileAnonymousLinkType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">AnonymousLinkType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FolderAnonymousLinkType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">AnonymousLinkType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NotifyOwnersWhenItemsReshared</maml:name> <maml:description> <maml:para>When this parameter is set to $true and another user re-shares a document from a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. The values are $true and $false.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NotifyOwnersWhenInvitationsAccepted</maml:name> <maml:description> <maml:para>When this parameter is set to $true and when an external user accepts an invitation to a resource in a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. The values are $true and $false.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NotificationsInOneDriveForBusinessEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NotificationsInSharePointEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OwnerAnonymousNotification</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CommentsOnSitePagesDisabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SocialBarOnSitePagesDisabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OrphanedPersonalSitesRetentionPeriod</maml:name> <maml:description> <maml:para>Specifies the number of days after a user's Active Directory account is deleted that their OneDrive for Business content will be deleted. The value range is in days, between 30 and 3650. The default value is 30.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisallowInfectedFileDownload</maml:name> <maml:description> <maml:para>Prevents the Download button from being displayed on the Virus Found warning page. Accepts a value of true (enabled) to hide the Download button or false (disabled) to display the Download button. By default this feature is set to false. </maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultLinkPermission</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SharingPermissionType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ConditionalAccessPolicy</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SPOConditionalAccessPolicyType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowDownloadingNonWebViewableFiles</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowEditing</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ApplyAppEnforcedRestrictionsToAdHocRecipients</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FilePickerExternalImageSearchEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EmailAttestationRequired</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EmailAttestationReAuthDays</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HideDefaultThemes</maml:name> <maml:description> <maml:para>Defines if the default themes are visible or hidden</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisabledWebPartIds</maml:name> <maml:description> <maml:para>Guids of out of the box modern web part id's to hide</maml:para> </maml:description> <command:parameterValue required="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AllowDownloadingNonWebViewableFiles</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowEditing</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ApplyAppEnforcedRestrictionsToAdHocRecipients</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BccExternalSharingInvitations</maml:name> <maml:description> <maml:para>When the feature is enabled, all external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingInvitationsList. The valid values are: False (default) - BCC for external sharing is disabled. True - All external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingInvitationsList.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BccExternalSharingInvitationsList</maml:name> <maml:description> <maml:para>Specifies a list of e-mail addresses to be BCC'd when the BCC for External Sharing feature is enabled. Multiple addresses can be specified by creating a comma separated list with no spaces. The valid values are: "" (default) - Blank by default, this will also clear any value that has been set. Single or Multiple e-mail addresses - joe@contoso.com or joe@contoso.com,bob@contoso.com</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CommentsOnSitePagesDisabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ConditionalAccessPolicy</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SPOConditionalAccessPolicyType</command:parameterValue> <dev:type> <maml:name>SPOConditionalAccessPolicyType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultLinkPermission</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SharingPermissionType</command:parameterValue> <dev:type> <maml:name>SharingPermissionType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultSharingLinkType</maml:name> <maml:description> <maml:para>Lets administrators choose what type of link appears is selected in the “Get a link” sharing dialog box in OneDrive for Business and SharePoint Online. For additional information about how to change the default link type, see Change the default link type when users get links for sharing. Note: Setting this value to “none” will default “get a link” to the most permissive link available (that is, if anonymous links are enabled, the default link will be anonymous access; if they are disabled then the default link will be internal. The values are: None Direct Internal AnonymousAccess</maml:para> </maml:description> <command:parameterValue required="false">SharingLinkType</command:parameterValue> <dev:type> <maml:name>SharingLinkType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisabledWebPartIds</maml:name> <maml:description> <maml:para>Guids of out of the box modern web part id's to hide</maml:para> </maml:description> <command:parameterValue required="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisallowInfectedFileDownload</maml:name> <maml:description> <maml:para>Prevents the Download button from being displayed on the Virus Found warning page. Accepts a value of true (enabled) to hide the Download button or false (disabled) to display the Download button. By default this feature is set to false. </maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayStartASiteOption</maml:name> <maml:description> <maml:para>Determines whether tenant users see the Start a Site menu option. The valid values are: True (default) - Tenant users will see the Start a Site menu option. False - Start a Site is hidden from the menu.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EmailAttestationReAuthDays</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EmailAttestationRequired</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableGuestSignInAcceleration</maml:name> <maml:description> <maml:para>Accelerates guest-enabled site collections as well as member-only site collections when the SignInAccelerationDomain parameter is set. Note: If enabled, your identity provider must be capable of authenticating guest users. If it is not, guest users will be unable to log in and access content that was shared with them.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExternalServicesEnabled</maml:name> <maml:description> <maml:para>Enables external services for a tenant. External services are defined as services that are not in the Office 365 datacenters. The valid values are: True (default) - External services are enabled for the tenant. False - External services that are outside of the Office 365 datacenters cannot interact with SharePoint.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FileAnonymousLinkType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">AnonymousLinkType</command:parameterValue> <dev:type> <maml:name>AnonymousLinkType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FilePickerExternalImageSearchEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FolderAnonymousLinkType</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">AnonymousLinkType</command:parameterValue> <dev:type> <maml:name>AnonymousLinkType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HideDefaultThemes</maml:name> <maml:description> <maml:para>Defines if the default themes are visible or hidden</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IPAddressAllowList</maml:name> <maml:description> <maml:para>Configures multiple IP addresses or IP address ranges (IPv4 or IPv6). Use commas to separate multiple IP addresses or IP address ranges. Verify there are no overlapping IP addresses and ensure IP ranges use Classless Inter-Domain Routing (CIDR) notation. For example, 172.16.0.0, 192.168.1.0/27. Note: The IPAddressAllowList parameter only lets administrators set IP addresses or ranges that are recognized as trusted. To only grant access from these IP addresses or ranges, set the IPAddressEnforcement parameter to $true.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IPAddressEnforcement</maml:name> <maml:description> <maml:para>Allows access from network locations that are defined by an administrator. The values are $true and $false. The default value is $false which means the setting is disabled. Before the IPAddressEnforcement parameter is set, make sure you add a valid IPv4 or IPv6 address to the IPAddressAllowList parameter.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IPAddressWACTokenLifetime</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LegacyAuthProtocolsEnabled</maml:name> <maml:description> <maml:para>By default this value is set to $true. Setting this parameter prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. A value of $true - Enables Office clients using non-modern authentication protocols(such as, Forms-Based Authentication (FBA) or Identity Client Runtime Library (IDCRL)) to access SharePoint resources. A value of $false - Prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. Note: This may also prevent third-party apps from accessing SharePoint Online resources.Also, this will also block apps using the SharePointOnlineCredentials class to access SharePoint Online resources.For additional information about SharePointOnlineCredentials, see SharePointOnlineCredentials class.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MaxCompatibilityLevel</maml:name> <maml:description> <maml:para>Specifies the upper bound on the compatibility level for new sites.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinCompatibilityLevel</maml:name> <maml:description> <maml:para>Specifies the lower bound on the compatibility level for new sites.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NoAccessRedirectUrl</maml:name> <maml:description> <maml:para>Specifies the URL of the redirected site for those site collections which have the locked state "NoAccess" The valid values are: ""(default) - Blank by default, this will also remove or clear any value that has been set. Full URL - Example: https://contoso.sharepoint.com/Pages/Locked.aspx</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NotificationsInOneDriveForBusinessEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NotificationsInSharePointEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NotifyOwnersWhenInvitationsAccepted</maml:name> <maml:description> <maml:para>When this parameter is set to $true and when an external user accepts an invitation to a resource in a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. The values are $true and $false.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NotifyOwnersWhenItemsReshared</maml:name> <maml:description> <maml:para>When this parameter is set to $true and another user re-shares a document from a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. The values are $true and $false.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ODBAccessRequests</maml:name> <maml:description> <maml:para>Lets administrators set policy on access requests and requests to share in OneDrive for Business. Values: On- Users without permission to share can trigger sharing requests to the OneDrive for Business owner when they attempt to share. Also, users without permission to a file or folder can trigger access requests to the OneDrive for Business owner when they attempt to access an item they do not have permissions to. Off- Prevent access requests and requests to share on OneDrive for Business. Unspecified- Let each OneDrive for Business owner enable or disable access requests and requests to share on their OneDrive.</maml:para> </maml:description> <command:parameterValue required="false">SharingState</command:parameterValue> <dev:type> <maml:name>SharingState</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ODBMembersCanShare</maml:name> <maml:description> <maml:para>Lets administrators set policy on re-sharing behavior in OneDrive for Business. Values: On- Users with edit permissions can re-share. Off- Only OneDrive for Business owner can share. The value of ODBAccessRequests defines whether a request to share gets sent to the owner. Unspecified- Let each OneDrive for Business owner enable or disable re-sharing behavior on their OneDrive.</maml:para> </maml:description> <command:parameterValue required="false">SharingState</command:parameterValue> <dev:type> <maml:name>SharingState</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OfficeClientADALDisabled</maml:name> <maml:description> <maml:para>When set to true this will disable the ability to use Modern Authentication that leverages ADAL across the tenant. The valid values are: False (default) - Modern Authentication is enabled/allowed. True - Modern Authentication via ADAL is disabled.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OneDriveForGuestsEnabled</maml:name> <maml:description> <maml:para>Lets OneDrive for Business creation for administrator managed guest users. Administrator managed Guest users use credentials in the resource tenant to access the resources. The valid values are the following: $true-Administrator managed Guest users can be given OneDrives, provided needed licenses are assigned. $false- Administrator managed Guest users can't be given OneDrives as functionality is turned off.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OneDriveStorageQuota</maml:name> <maml:description> <maml:para>Sets a default OneDrive for Business storage quota for the tenant. It will be used for new OneDrive for Business sites created. A typical use will be to reduce the amount of storage associated with OneDrive for Business to a level below what the License entitles the users. For example, it could be used to set the quota to 10 gigabytes (GB) by default. If value is set to 0, the parameter will have no effect. If the value is set larger than the Maximum allowed OneDrive for Business quota, it will have no effect.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OrphanedPersonalSitesRetentionPeriod</maml:name> <maml:description> <maml:para>Specifies the number of days after a user's Active Directory account is deleted that their OneDrive for Business content will be deleted. The value range is in days, between 30 and 3650. The default value is 30.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>OwnerAnonymousNotification</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PreventExternalUsersFromResharing</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProvisionSharedWithEveryoneFolder</maml:name> <maml:description> <maml:para>Creates a Shared with Everyone folder in every user's new OneDrive for Business document library. The valid values are: True (default) - The Shared with Everyone folder is created. False - No folder is created when the site and OneDrive for Business document library is created. The default behavior of the Shared with Everyone folder changed in August 2015. For additional information about the change, see Provision the Shared with Everyone folder in OneDrive for Business (https://support.office.com/en-us/article/Provision-the-Shared-with-Everyone-folder-in-OneDrive-for-Business-6bb02c91-fd0b-42ba-9457-3921cb6dc5b2?ui=en-US&rs=en-US&ad=US)</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublicCdnAllowedFileTypes</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>PublicCdnEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequireAcceptingAccountMatchInvitedAccount</maml:name> <maml:description> <maml:para>Ensures that an external user can only accept an external sharing invitation with an account matching the invited email address. Administrators who desire increased control over external collaborators should consider enabling this feature. Note, this only applies to new external users accepting new sharing invitations. Also, the resource owner must share with an organizational or Microsoft account or the external user will be unable to access the resource. The valid values are: False (default) - When a document is shared with an external user, bob@contoso.com, it can be accepted by any user with access to the invitation link in the original e-mail. True - User must accept this invitation with bob@contoso.com.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RequireAnonymousLinksExpireInDays</maml:name> <maml:description> <maml:para>Specifies all anonymous links that have been created (or will be created) will expire after the set number of days . To remove the expiration requirement, set the value to zero (0).</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SearchResolveExactEmailOrUPN</maml:name> <maml:description> <maml:para>Removes the search capability from People Picker. Note, recently resolved names will still appear in the list until browser cache is cleared or expired. SharePoint Administrators will still be able to use starts with or partial name matching when enabled. The valid values are: False (default) - Starts with / partial name search functionality is available. True - Disables starts with / partial name search functionality for all SharePoint users, except SharePoint Admins.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingAllowedDomainList</maml:name> <maml:description> <maml:para>Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingBlockedDomainList</maml:name> <maml:description> <maml:para>Specifies a list of email domains that is blocked or prohibited for sharing with the external collaborators. Use space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingCapability</maml:name> <maml:description> <maml:para>Determines what level of sharing is available for the site. The valid values are: ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled. Disabled - External user sharing (share by email) and guest link sharing are both disabled. ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing is disabled. For more information about sharing, see Manage external sharing for your SharePoint online environment (http://office.microsoft.com/en-us/office365-sharepoint-online-enterprise-help/manage-external-sharing-for-your-sharepoint-online-environment-HA102849864.aspx).</maml:para> </maml:description> <command:parameterValue required="false">SharingCapabilities</command:parameterValue> <dev:type> <maml:name>SharingCapabilities</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingDomainRestrictionMode</maml:name> <maml:description> <maml:para>Specifies the external sharing mode for domains. The following values are: None AllowList BlockList For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business.</maml:para> </maml:description> <command:parameterValue required="false">SharingDomainRestrictionModes</command:parameterValue> <dev:type> <maml:name>SharingDomainRestrictionModes</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShowAllUsersClaim</maml:name> <maml:description> <maml:para>Enables the administrator to hide the All Users claim groups in People Picker. When users share an item with "All Users (x)", it is accessible to all organization members in the tenant's Azure Active Directory who have authenticated with via this method. When users share an item with "All Users (x)" it is accessible to all organization members in the tenant that used NTLM to authentication with SharePoint. Note, the All Users(authenticated) group is equivalent to the Everyone claim, and shows as Everyone.To change this, see - ShowEveryoneClaim. The valid values are: True(default) - The All Users claim groups are displayed in People Picker. False - The All Users claim groups are hidden in People Picker.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShowEveryoneClaim</maml:name> <maml:description> <maml:para>Enables the administrator to hide the Everyone claim in the People Picker. When users share an item with Everyone, it is accessible to all authenticated users in the tenant's Azure Active Directory, including any active external users who have previously accepted invitations. Note, that some SharePoint system resources such as templates and pages are required to be shared to Everyone and this type of sharing does not expose any user data or metadata. The valid values are: True (default) - The Everyone claim group is displayed in People Picker. False - The Everyone claim group is hidden from the People Picker.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShowEveryoneExceptExternalUsersClaim</maml:name> <maml:description> <maml:para>Enables the administrator to hide the "Everyone except external users" claim in the People Picker. When users share an item with "Everyone except external users", it is accessible to all organization members in the tenant's Azure Active Directory, but not to any users who have previously accepted invitations. The valid values are: True(default) - The Everyone except external users is displayed in People Picker. False - The Everyone except external users claim is not visible in People Picker.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ShowPeoplePickerSuggestionsForGuestUsers</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SignInAccelerationDomain</maml:name> <maml:description> <maml:para>Specifies the home realm discovery value to be sent to Azure Active Directory (AAD) during the user sign-in process. When the organization uses a third-party identity provider, this prevents the user from seeing the Azure Active Directory Home Realm Discovery web page and ensures the user only sees their company's Identity Provider's portal. This value can also be used with Azure Active Directory Premium to customize the Azure Active Directory login page. Acceleration will not occur on site collections that are shared externally. This value should be configured with the login domain that is used by your company (that is, example@contoso.com). If your company has multiple third-party identity providers, configuring the sign-in acceleration value will break sign-in for your organization. The valid values are: "" (default) - Blank by default, this will also remove or clear any value that has been set. Login Domain - For example: "contoso.com"</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SocialBarOnSitePagesDisabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartASiteFormUrl</maml:name> <maml:description> <maml:para>Specifies URL of the form to load in the Start a Site dialog. The valid values are: "" (default) - Blank by default, this will also remove or clear any value that has been set. Full URL - Example: "https://contoso.sharepoint.com/path/to/form"</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UseFindPeopleInPeoplePicker</maml:name> <maml:description> <maml:para>Note: When set to $true, users aren't able to share with security groups or SharePoint groups.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsePersistentCookiesForExplorerView</maml:name> <maml:description> <maml:para>Lets SharePoint issue a special cookie that will allow this feature to work even when "Keep Me Signed In" is not selected. "Open with Explorer" requires persisted cookies to operate correctly. When the user does not select "Keep Me Signed in" at the time of sign -in, "Open with Explorer" will fail. This special cookie expires after 30 minutes and cannot be cleared by closing the browser or signing out of SharePoint Online.To clear this cookie, the user must log out of their Windows session. The valid values are: False(default) - No special cookie is generated and the normal Office 365 sign -in length / timing applies. True - Generates a special cookie that will allow "Open with Explorer" to function if the "Keep Me Signed In" box is not checked at sign -in.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UserVoiceForFeedbackEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTenantSite -Identity https://contoso.sharepoint.com/sites/team1 -LockState NoAccess Set-PnPTenant -NoAccessRedirectUrl 'http://www.contoso.com'</dev:code> <maml:remarks> <maml:para>This example blocks access to https://contoso.sharepoint.com/sites/team1 and redirects traffic to http://www.contoso.com.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTenant -ShowEveryoneExceptExternalUsersClaim $false</dev:code> <maml:remarks> <maml:para>This example hides the "Everyone Except External Users" claim in People Picker.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTenant -ShowAllUsersClaim $false</dev:code> <maml:remarks> <maml:para>This example hides the "All Users" claim group in People Picker.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTenant -UsePersistentCookiesForExplorerView $true</dev:code> <maml:remarks> <maml:para>This example enables the use of special persisted cookie for Open with Explorer.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPTenantAppCatalogUrl</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Sets the url of the tenant scoped app catalog</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPTenantAppCatalogUrl</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPTenantAppCatalogUrl</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The url of the site to set as the tenant scoped app catalog</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The url of the site to set as the tenant scoped app catalog</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTenantAppCatalogUrl -Url https://yourtenant.sharepoint.com/sites/appcatalog</dev:code> <maml:remarks> <maml:para>Sets the tenant scoped app catalog to the provided site collection url</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPTenantCdnEnabled</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Enables or disabled the public or private Office 365 Content Delivery Network (CDN).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPTenantCdnEnabled</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Enables or disabled the public or private Office 365 Content Delivery Network (CDN).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPTenantCdnEnabled</maml:name> <command:parameter required="true" position="named"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Specify to enable or disable</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>The type of cdn to enable or disable</maml:para> </maml:description> <command:parameterValue required="true">CdnType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>The type of cdn to enable or disable</maml:para> </maml:description> <command:parameterValue required="true">CdnType</command:parameterValue> <dev:type> <maml:name>CdnType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Specify to enable or disable</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTenantCdnEnabled -CdnType Public -Enable $true</dev:code> <maml:remarks> <maml:para>This example sets the Public CDN enabled.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPTenantCdnPolicy</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Sets the CDN Policies for the specified CDN (Public | Private).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPTenantCdnPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets the CDN Policies for the specified CDN (Public | Private).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPTenantCdnPolicy</maml:name> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>The type of cdn to retrieve the policies from</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PolicyType</maml:name> <maml:description> <maml:para>The type of the policy to set</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnPolicyType</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PolicyValue</maml:name> <maml:description> <maml:para>The value of the policy to set</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>The type of cdn to retrieve the policies from</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnType</command:parameterValue> <dev:type> <maml:name>SPOTenantCdnType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PolicyType</maml:name> <maml:description> <maml:para>The type of the policy to set</maml:para> </maml:description> <command:parameterValue required="true">SPOTenantCdnPolicyType</command:parameterValue> <dev:type> <maml:name>SPOTenantCdnPolicyType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PolicyValue</maml:name> <maml:description> <maml:para>The value of the policy to set</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTenantCdnPolicy -CdnType Public -PolicyType IncludeFileExtensions -PolicyValue "CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF"</dev:code> <maml:remarks> <maml:para>This example sets the IncludeFileExtensions policy to the specified value.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPTenantSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Set site information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPTenantSite</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets site properties for existing sites.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPTenantSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingCapability</maml:name> <maml:description> <maml:para>Specifies what the sharing capabilities are for the site. Possible values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly</maml:para> </maml:description> <command:parameterValue required="true">SharingCapabilities</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DenyAddAndCustomizePages</maml:name> <maml:description> <maml:para>Determines whether the Add And Customize Pages right is denied on the site collection. For more information about permission levels, see User permissions and permission levels in SharePoint.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LocaleId</maml:name> <maml:description> <maml:para>Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft (https://go.microsoft.com/fwlink/p/?LinkId=242911).</maml:para> </maml:description> <command:parameterValue required="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageMaximumLevel</maml:name> <maml:description> <maml:para>Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota.</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageWarningLevel</maml:name> <maml:description> <maml:para>Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageMaximumLevel parameter</maml:para> </maml:description> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AllowSelfServiceUpgrade</maml:name> <maml:description> <maml:para>Specifies if the site administrator can upgrade the site collection</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies owner(s) to add as site collection administrators. They will be added as additional site collection administrators. Existing administrators will stay. Can be both users and groups.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultLinkPermission</maml:name> <maml:description> <maml:para>Specifies the default link permission for the site collection. None - Respect the organization default link permission. View - Sets the default link permission for the site to "view" permissions. Edit - Sets the default link permission for the site to "edit" permissions</maml:para> </maml:description> <command:parameterValue required="true">SharingPermissionType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultSharingLinkType</maml:name> <maml:description> <maml:para>Specifies the default link type for the site collection. None - Respect the organization default sharing link type. AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link. Internal - Sets the default sharing link for this site to the "organization" link or company shareable link. Direct - Sets the default sharing link for this site to the "Specific people" link</maml:para> </maml:description> <command:parameterValue required="true">SharingLinkType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingAllowedDomainList</maml:name> <maml:description> <maml:para>Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com".</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingBlockedDomainList</maml:name> <maml:description> <maml:para>Specifies a list of email domains that is blocked for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com".</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BlockDownloadOfNonViewableFiles</maml:name> <maml:description> <maml:para>Specifies if non web viewable files can be downloaded.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingDomainRestrictionMode</maml:name> <maml:description> <maml:para>Specifies the external sharing mode for domains.</maml:para> </maml:description> <command:parameterValue required="true">SharingDomainRestrictionModes</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CommentsOnSitePagesDisabled</maml:name> <maml:description> <maml:para>Specifies if comments on site pages are enabled</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableAppViews</maml:name> <maml:description> <maml:para>-</maml:para> </maml:description> <command:parameterValue required="true">AppViewsPolicy</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableCompanyWideSharingLinks</maml:name> <maml:description> <maml:para>-</maml:para> </maml:description> <command:parameterValue required="true">CompanyWideSharingLinksPolicy</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableFlows</maml:name> <maml:description> <maml:para>-</maml:para> </maml:description> <command:parameterValue required="true">FlowsPolicy</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for the operation to complete</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPTenantSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LockState</maml:name> <maml:description> <maml:para>Sets the lockstate of a site</maml:para> </maml:description> <command:parameterValue required="true">SiteLockState</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for the operation to complete</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AllowSelfServiceUpgrade</maml:name> <maml:description> <maml:para>Specifies if the site administrator can upgrade the site collection</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BlockDownloadOfNonViewableFiles</maml:name> <maml:description> <maml:para>Specifies if non web viewable files can be downloaded.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CommentsOnSitePagesDisabled</maml:name> <maml:description> <maml:para>Specifies if comments on site pages are enabled</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultLinkPermission</maml:name> <maml:description> <maml:para>Specifies the default link permission for the site collection. None - Respect the organization default link permission. View - Sets the default link permission for the site to "view" permissions. Edit - Sets the default link permission for the site to "edit" permissions</maml:para> </maml:description> <command:parameterValue required="false">SharingPermissionType</command:parameterValue> <dev:type> <maml:name>SharingPermissionType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultSharingLinkType</maml:name> <maml:description> <maml:para>Specifies the default link type for the site collection. None - Respect the organization default sharing link type. AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link. Internal - Sets the default sharing link for this site to the "organization" link or company shareable link. Direct - Sets the default sharing link for this site to the "Specific people" link</maml:para> </maml:description> <command:parameterValue required="false">SharingLinkType</command:parameterValue> <dev:type> <maml:name>SharingLinkType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DenyAddAndCustomizePages</maml:name> <maml:description> <maml:para>Determines whether the Add And Customize Pages right is denied on the site collection. For more information about permission levels, see User permissions and permission levels in SharePoint.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableAppViews</maml:name> <maml:description> <maml:para>-</maml:para> </maml:description> <command:parameterValue required="false">AppViewsPolicy</command:parameterValue> <dev:type> <maml:name>AppViewsPolicy</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableCompanyWideSharingLinks</maml:name> <maml:description> <maml:para>-</maml:para> </maml:description> <command:parameterValue required="false">CompanyWideSharingLinksPolicy</command:parameterValue> <dev:type> <maml:name>CompanyWideSharingLinksPolicy</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisableFlows</maml:name> <maml:description> <maml:para>-</maml:para> </maml:description> <command:parameterValue required="false">FlowsPolicy</command:parameterValue> <dev:type> <maml:name>FlowsPolicy</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LocaleId</maml:name> <maml:description> <maml:para>Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft (https://go.microsoft.com/fwlink/p/?LinkId=242911).</maml:para> </maml:description> <command:parameterValue required="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LockState</maml:name> <maml:description> <maml:para>Sets the lockstate of a site</maml:para> </maml:description> <command:parameterValue required="false">SiteLockState</command:parameterValue> <dev:type> <maml:name>SiteLockState</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies owner(s) to add as site collection administrators. They will be added as additional site collection administrators. Existing administrators will stay. Can be both users and groups.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingAllowedDomainList</maml:name> <maml:description> <maml:para>Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingBlockedDomainList</maml:name> <maml:description> <maml:para>Specifies a list of email domains that is blocked for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com".</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingCapability</maml:name> <maml:description> <maml:para>Specifies what the sharing capabilities are for the site. Possible values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly</maml:para> </maml:description> <command:parameterValue required="false">SharingCapabilities</command:parameterValue> <dev:type> <maml:name>SharingCapabilities</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SharingDomainRestrictionMode</maml:name> <maml:description> <maml:para>Specifies the external sharing mode for domains.</maml:para> </maml:description> <command:parameterValue required="false">SharingDomainRestrictionModes</command:parameterValue> <dev:type> <maml:name>SharingDomainRestrictionModes</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageMaximumLevel</maml:name> <maml:description> <maml:para>Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota.</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StorageWarningLevel</maml:name> <maml:description> <maml:para>Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageMaximumLevel parameter</maml:para> </maml:description> <command:parameterValue required="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specifies the title of the site</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for the operation to complete</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTenantSite -Url https://contoso.sharepoint.com -Title "Contoso Website" -Sharing Disabled</dev:code> <maml:remarks> <maml:para>This will set the title of the site collection with the URL 'https://contoso.sharepoint.com' to 'Contoso Website' and disable sharing on this site collection.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTenantSite -Url https://contoso.sharepoint.com -Title "Contoso Website" -StorageWarningLevel 8000 -StorageMaximumLevel 10000</dev:code> <maml:remarks> <maml:para>This will set the title of the site collection with the URL 'https://contoso.sharepoint.com' to 'Contoso Website', set the storage warning level to 8GB and set the storage maximum level to 10GB.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTenantSite -Url https://contoso.sharepoint.com/sites/sales -Owners "user@contoso.onmicrosoft.com"</dev:code> <maml:remarks> <maml:para>This will add user@contoso.onmicrosoft.com as an additional site collection owner at 'https://contoso.sharepoint.com/sites/sales'.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTenantSite -Url https://contoso.sharepoint.com/sites/sales -Owners @("user1@contoso.onmicrosoft.com", "user2@contoso.onmicrosoft.com")</dev:code> <maml:remarks> <maml:para>This will add user1@contoso.onmicrosoft.com and user2@contoso.onmicrosoft.com as additional site collection owners at 'https://contoso.sharepoint.com/sites/sales'.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTenantSite -Url https://contoso.sharepoint.com/sites/sales -NoScriptSite:$false</dev:code> <maml:remarks> <maml:para>This will enable script support for the site 'https://contoso.sharepoint.com/sites/sales' if disabled.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPTheme</command:name> <maml:description> <maml:para>Sets the theme of the current web.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPTheme</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> Sets the theme of the current web, if any of the attributes is not set, that value will be set to null</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPTheme</maml:name> <command:parameter required="false" position="named"> <maml:name>ColorPaletteUrl</maml:name> <maml:description> <maml:para>Specifies the Color Palette Url based on the site or server relative url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FontSchemeUrl</maml:name> <maml:description> <maml:para>Specifies the Font Scheme Url based on the site or server relative url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>BackgroundImageUrl</maml:name> <maml:description> <maml:para>Specifies the Background Image Url based on the site or server relative url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResetSubwebsToInherit</maml:name> <maml:description> <maml:para>Resets subwebs to inherit the theme from the rootweb</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UpdateRootWebOnly</maml:name> <maml:description> <maml:para>Updates only the rootweb, even if subwebs are set to inherit the theme.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>BackgroundImageUrl</maml:name> <maml:description> <maml:para>Specifies the Background Image Url based on the site or server relative url</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ColorPaletteUrl</maml:name> <maml:description> <maml:para>Specifies the Color Palette Url based on the site or server relative url</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>FontSchemeUrl</maml:name> <maml:description> <maml:para>Specifies the Font Scheme Url based on the site or server relative url</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ResetSubwebsToInherit</maml:name> <maml:description> <maml:para>Resets subwebs to inherit the theme from the rootweb</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UpdateRootWebOnly</maml:name> <maml:description> <maml:para>Updates only the rootweb, even if subwebs are set to inherit the theme.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTheme</dev:code> <maml:remarks> <maml:para>Removes the current theme and resets it to the default.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTheme -ColorPaletteUrl _catalogs/theme/15/company.spcolor</dev:code> <maml:remarks> <maml:para /> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTheme -ColorPaletteUrl _catalogs/theme/15/company.spcolor -BackgroundImageUrl 'style library/background.png'</dev:code> <maml:remarks> <maml:para /> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTheme -ColorPaletteUrl _catalogs/theme/15/company.spcolor -BackgroundImageUrl 'style library/background.png' -ResetSubwebsToInherit</dev:code> <maml:remarks> <maml:para>Sets the theme to the web, and updates all subwebs to inherit the theme from this web.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPTraceLog</command:name> <maml:description> <maml:para>Turn log tracing on or off</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPTraceLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Defines if tracing should be turned on. PnP Core, which is the foundation of these cmdlets, uses the standard Trace functionality of .NET. With this cmdlet you can turn capturing of this trace to a log file on or off. Notice that basically only the Provisioning Engine writes to the tracelog which means that cmdlets related to the engine will produce output.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPTraceLog</maml:name> <command:parameter required="true" position="named"> <maml:name>On</maml:name> <maml:description> <maml:para>Turn on tracing to log file</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogFile</maml:name> <maml:description> <maml:para>The path and filename of the file to write the trace log to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WriteToConsole</maml:name> <maml:description> <maml:para>Turn on console trace output.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The level of events to capture. Possible values are 'Debug', 'Error', 'Warning', 'Information'. Defaults to 'Information'.</maml:para> </maml:description> <command:parameterValue required="true">LogLevel</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para>If specified the trace log entries will be delimited with this value.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IndentSize</maml:name> <maml:description> <maml:para>Indents in the tracelog will be with this amount of characters. Defaults to 4.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AutoFlush</maml:name> <maml:description> <maml:para>Auto flush the trace log. Defaults to true.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPTraceLog</maml:name> <command:parameter required="true" position="named"> <maml:name>Off</maml:name> <maml:description> <maml:para>Turn off tracing to log file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AutoFlush</maml:name> <maml:description> <maml:para>Auto flush the trace log. Defaults to true.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para>If specified the trace log entries will be delimited with this value.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IndentSize</maml:name> <maml:description> <maml:para>Indents in the tracelog will be with this amount of characters. Defaults to 4.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The level of events to capture. Possible values are 'Debug', 'Error', 'Warning', 'Information'. Defaults to 'Information'.</maml:para> </maml:description> <command:parameterValue required="false">LogLevel</command:parameterValue> <dev:type> <maml:name>LogLevel</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>LogFile</maml:name> <maml:description> <maml:para>The path and filename of the file to write the trace log to.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Off</maml:name> <maml:description> <maml:para>Turn off tracing to log file.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>On</maml:name> <maml:description> <maml:para>Turn on tracing to log file</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WriteToConsole</maml:name> <maml:description> <maml:para>Turn on console trace output.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTraceLog -On -LogFile traceoutput.txt</dev:code> <maml:remarks> <maml:para>This turns on trace logging to the file 'traceoutput.txt' and will capture events of at least 'Information' level.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTraceLog -On -LogFile traceoutput.txt -Level Debug</dev:code> <maml:remarks> <maml:para>This turns on trace logging to the file 'traceoutput.txt' and will capture debug events.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTraceLog -On -LogFile traceoutput.txt -Level Debug -Delimiter ","</dev:code> <maml:remarks> <maml:para>This turns on trace logging to the file 'traceoutput.txt' and will write the entries as comma separated. Debug events are captured.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPTraceLog -Off</dev:code> <maml:remarks> <maml:para>This turns off trace logging. It will flush any remaining messages to the log file.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPUnifiedGroup</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Sets Office 365 Group (aka Unified Group) properties. Requires the Azure Active Directory application permission 'Group.ReadWrite.All'.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPUnifiedGroup</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPUnifiedGroup</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The DisplayName of the group to set.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description of the group to set.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>The array UPN values of owners to set to the group. Note: Will replace owners.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>The array UPN values of members to set to the group. Note: Will replace members.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsPrivate</maml:name> <maml:description> <maml:para>Makes the group private when selected.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GroupLogoPath</maml:name> <maml:description> <maml:para>The path to the logo file of to set.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CreateTeam</maml:name> <maml:description> <maml:para>Creates a MS Teams team associated with created group.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>CreateTeam</maml:name> <maml:description> <maml:para>Creates a MS Teams team associated with created group.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description of the group to set.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The DisplayName of the group to set.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>GroupLogoPath</maml:name> <maml:description> <maml:para>The path to the logo file of to set.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Office 365 Group.</maml:para> </maml:description> <command:parameterValue required="true">UnifiedGroupPipeBind</command:parameterValue> <dev:type> <maml:name>UnifiedGroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>IsPrivate</maml:name> <maml:description> <maml:para>Makes the group private when selected.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>The array UPN values of members to set to the group. Note: Will replace members.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Owners</maml:name> <maml:description> <maml:para>The array UPN values of owners to set to the group. Note: Will replace owners.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPUnifiedGroup -Identity $group -DisplayName "My Displayname"</dev:code> <maml:remarks> <maml:para>Sets the display name of the group where $group is a Group entity</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPUnifiedGroup -Identity $groupId -Descriptions "My Description" -DisplayName "My DisplayName"</dev:code> <maml:remarks> <maml:para>Sets the display name and description of a group based upon its ID</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPUnifiedGroup -Identity $group -GroupLogoPath ".\MyLogo.png"</dev:code> <maml:remarks> <maml:para>Sets a specific Office 365 Group logo.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPUnifiedGroup -Identity $group -IsPrivate:$false</dev:code> <maml:remarks> <maml:para>Sets a group to be Public if previously Private.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 5---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPUnifiedGroup -Identity $group -Owners demo@contoso.com</dev:code> <maml:remarks> <maml:para>Sets demo@contoso.com as owner of the group.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPUserProfileProperty</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Office365 only: Uses the tenant API to retrieve site information. You must connect to the tenant admin website (https://:<tenant>-admin.sharepoint.com) with Connect-PnPOnline in order to use this command. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPUserProfileProperty</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Requires a connection to a SharePoint Tenant Admin site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPUserProfileProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value to set in the case of a single value property</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Account</maml:name> <maml:description> <maml:para>The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PropertyName</maml:name> <maml:description> <maml:para>The property to set, for instance SPS-Skills or SPS-Location</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPUserProfileProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>The values set in the case of a multi value property, e.g. "Value 1","Value 2"</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Account</maml:name> <maml:description> <maml:para>The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PropertyName</maml:name> <maml:description> <maml:para>The property to set, for instance SPS-Skills or SPS-Location</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Account</maml:name> <maml:description> <maml:para>The account of the user, formatted either as a login name, or as a claims identity, e.g. i:0#.f|membership|user@domain.com</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PropertyName</maml:name> <maml:description> <maml:para>The property to set, for instance SPS-Skills or SPS-Location</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value to set in the case of a single value property</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>The values set in the case of a multi value property, e.g. "Value 1","Value 2"</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'SPS-Location' -Value 'Stockholm'</dev:code> <maml:remarks> <maml:para>Sets the SPS-Location property for the user as specified by the Account parameter</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'MyProperty' -Values 'Value 1','Value 2'</dev:code> <maml:remarks> <maml:para>Sets the MyProperty multi value property for the user as specified by the Account parameter</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPView</command:name> <maml:description> <maml:para>Change view properties</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPView</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets one or more properties of an existing view, see here https://docs.microsoft.com/previous-versions/office/sharepoint-server/ee543328(v=office.15) for the list of view properties.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPView</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id, Title or instance of the view</maml:para> </maml:description> <command:parameterValue required="true">ViewPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Hashtable of properties to update on the view. Use the syntax @{property1="value";property2="value"}.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>An array of fields to use in the view. Notice that specifying this value will remove the existing fields</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Aggregations</maml:name> <maml:description> <maml:para>A valid XML fragment containing one or more Aggregations</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The Id, Title or Url of the list</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Aggregations</maml:name> <maml:description> <maml:para>A valid XML fragment containing one or more Aggregations</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>An array of fields to use in the view. Notice that specifying this value will remove the existing fields</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id, Title or instance of the view</maml:para> </maml:description> <command:parameterValue required="true">ViewPipeBind</command:parameterValue> <dev:type> <maml:name>ViewPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The Id, Title or Url of the list</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Hashtable of properties to update on the view. Use the syntax @{property1="value";property2="value"}.</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SharePoint.Client.Field</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPView -List "Tasks" -Identity "All Tasks" -Values @{JSLink="hierarchytaskslist.js|customrendering.js";Title="My view"}</dev:code> <maml:remarks> <maml:para>Updates the "All Tasks" view on list "Tasks" to use hierarchytaskslist.js and customrendering.js for the JSLink and changes the title of the view to "My view"</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPList -Identity "Tasks" | Get-PnPView | Set-PnPView -Values @{JSLink="hierarchytaskslist.js|customrendering.js"}</dev:code> <maml:remarks> <maml:para>Updates all views on list "Tasks" to use hierarchytaskslist.js and customrendering.js for the JSLink</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPView -List "Documents" -Identity "Corporate Documents" -Fields "Title","Created"</dev:code> <maml:remarks> <maml:para>Updates the Corporate Documents view on the Documents library to have two fields</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPView -List "Documents" -Identity "Corporate Documents" -Fields "Title","Created" -Aggregations "<FieldRef Name='Title' Type='COUNT'/>"</dev:code> <maml:remarks> <maml:para>Updates the Corporate Documents view on the Documents library and sets the totals (aggregations) to Count on the Title field</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPWeb</command:name> <maml:description> <maml:para>Sets properties on a web</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPWeb</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets properties on a web</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPWeb</maml:name> <command:parameter required="false" position="named"> <maml:name>SiteLogoUrl</maml:name> <maml:description> <maml:para>Sets the logo of the web to the current url. If you want to set the logo to a modern team site, use Set-PnPSite -LogoFilePath.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AlternateCssUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MasterUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomMasterUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HeaderLayout</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">HeaderLayoutType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HeaderEmphasis</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">SPVariantThemeType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AlternateCssUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CustomMasterUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HeaderEmphasis</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">SPVariantThemeType</command:parameterValue> <dev:type> <maml:name>SPVariantThemeType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HeaderLayout</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">HeaderLayoutType</command:parameterValue> <dev:type> <maml:name>HeaderLayoutType</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MasterUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SiteLogoUrl</maml:name> <maml:description> <maml:para>Sets the logo of the web to the current url. If you want to set the logo to a modern team site, use Set-PnPSite -LogoFilePath.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPWebhookSubscription</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Updates a Webhook subscription</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPWebhookSubscription</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPWebhookSubscription</maml:name> <command:parameter required="true" position="named"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The identity of the Webhook subscription to update</maml:para> </maml:description> <command:parameterValue required="true">WebhookSubscriptionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name from which the Webhook subscription will be modified</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NotificationUrl</maml:name> <maml:description> <maml:para>The URL of the Webhook endpoint that will be notified of the change</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ExpirationDate</maml:name> <maml:description> <maml:para>The date at which the Webhook subscription will expire. (Default: 6 months from today)</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>ExpirationDate</maml:name> <maml:description> <maml:para>The date at which the Webhook subscription will expire. (Default: 6 months from today)</maml:para> </maml:description> <command:parameterValue required="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name from which the Webhook subscription will be modified</maml:para> </maml:description> <command:parameterValue required="false">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>NotificationUrl</maml:name> <maml:description> <maml:para>The URL of the Webhook endpoint that will be notified of the change</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The identity of the Webhook subscription to update</maml:para> </maml:description> <command:parameterValue required="true">WebhookSubscriptionPipeBind</command:parameterValue> <dev:type> <maml:name>WebhookSubscriptionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OfficeDevPnP.Core.Entities.WebhookSubscription</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPWebhookSubscription -List MyList -Subscription ea1533a8-ff03-415b-a7b6-517ee50db8b6 -NotificationUrl https://my-func.azurewebsites.net/webhook</dev:code> <maml:remarks> <maml:para>Updates an existing Webhook subscription with the specified id on the list MyList with a new Notification Url</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPWebhookSubscription -List MyList -Subscription ea1533a8-ff03-415b-a7b6-517ee50db8b6 -NotificationUrl https://my-func.azurewebsites.net/webhook -ExpirationDate "2017-09-01"</dev:code> <maml:remarks> <maml:para>Updates an existing Webhook subscription with the specified id on the list MyList with a new Notification Url and a new expiration date</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> $subscriptions = Get-PnPWebhookSubscriptions -List MyList PS:> $updated = $subscriptions[0] PS:> $updated.ExpirationDate = "2017-10-01" PS:> Set-PnPWebhookSubscription -List MyList -Subscription $updated</dev:code> <maml:remarks> <maml:para>Updates the Webhook subscription from the list MyList with a modified subscription object. Note: The date will be converted to Universal Time</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPWebPartProperty</command:name> <maml:description> <maml:para>Sets a web part property</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPWebPartProperty</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPWebPartProperty</maml:name> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the web part page, e.g. /sites/demo/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Guid of the web part</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Name of a single property to be set</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value of the property to be set</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Guid of the web part</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Name of a single property to be set</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Full server relative url of the web part page, e.g. /sites/demo/sitepages/home.aspx</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value of the property to be set</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914 -Key "Title" -Value "New Title" </dev:code> <maml:remarks> <maml:para>Sets the title property of the web part.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPWebPermission</command:name> <maml:description> <maml:para>Set permissions</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPWebPermission</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets web permissions</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPWebPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPWebPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPWebPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity/Id/Web object</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPWebPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity/Id/Web object</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPWebPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The site relative url of the web, e.g. 'Subweb1'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPWebPermission</maml:name> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The site relative url of the web, e.g. 'Subweb1'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>AddRole</maml:name> <maml:description> <maml:para>The role that must be assigned to the group or user</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">GroupPipeBind</command:parameterValue> <dev:type> <maml:name>GroupPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity/Id/Web object</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RemoveRole</maml:name> <maml:description> <maml:para>The role that must be removed from the group or user</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The site relative url of the web, e.g. 'Subweb1'</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPWebPermission -Url projectA -User 'user@contoso.com' -AddRole 'Contribute'</dev:code> <maml:remarks> <maml:para>Adds the 'Contribute' permission to the user 'user@contoso.com' for a web, specified by its site relative url</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPWebPermission -Identity 5fecaf67-6b9e-4691-a0ff-518fc9839aa0 -User 'user@contoso.com' -RemoveRole 'Contribute'</dev:code> <maml:remarks> <maml:para>Removes the 'Contribute' permission to the user 'user@contoso.com' for a web, specified by its ID</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPWebTheme</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Sets the theme of the current web.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPWebTheme</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets the theme of the current web. * Requires Tenant Administration Rights *</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPWebTheme</maml:name> <command:parameter required="false" position="named"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the web to apply the theme to. If not specified it will default to the current web based upon the URL specified with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Theme</maml:name> <maml:description> <maml:para>Specifies the Color Palette Url based on the site or server relative url</maml:para> </maml:description> <command:parameterValue required="true">ThemePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Theme</maml:name> <maml:description> <maml:para>Specifies the Color Palette Url based on the site or server relative url</maml:para> </maml:description> <command:parameterValue required="false">ThemePipeBind</command:parameterValue> <dev:type> <maml:name>ThemePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the web to apply the theme to. If not specified it will default to the current web based upon the URL specified with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Set-PnPWebTheme -Theme MyTheme</dev:code> <maml:remarks> <maml:para>Sets the theme named "MyTheme" to the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Get-PnPTenantTheme -Name "MyTheme" | Set-PnPWebTheme</dev:code> <maml:remarks> <maml:para>Sets the theme named "MyTheme" to the current web</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-PnPWikiPageContent</command:name> <maml:description> <maml:para>Sets the contents of a wikipage</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PnPWikiPageContent</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Set-PnPWikiPageContent</maml:name> <command:parameter required="true" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Site Relative Page Url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PnPWikiPageContent</maml:name> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Site Relative Page Url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>Site Relative Page Url</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Copy-PnPItemProxy</command:name> <maml:description> <maml:para>Proxy cmdlet for using Copy-Item between SharePoint provider and FileSystem provider</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>PnPItemProxy</command:noun> <dev:version /> </command:details> <command:syntax /> <command:parameters /> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-PnPItemProxy</command:name> <maml:description> <maml:para>Proxy cmdlet for using Move-Item between SharePoint provider and FileSystem provider</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>PnPItemProxy</command:noun> <dev:version /> </command:details> <command:syntax /> <command:parameters /> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-PnPWorkflowInstance</command:name> <maml:description> <maml:para>Starts a workflow instance on a list item</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>PnPWorkflowInstance</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Start-PnPWorkflowInstance</maml:name> <command:parameter required="true" position="named"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The workflow subscription to start</maml:para> </maml:description> <command:parameterValue required="true">WorkflowSubscriptionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ListItem</maml:name> <maml:description> <maml:para>The list item to start the workflow against</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="1"> <maml:name>ListItem</maml:name> <maml:description> <maml:para>The list item to start the workflow against</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> <dev:type> <maml:name>ListItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The workflow subscription to start</maml:para> </maml:description> <command:parameterValue required="true">WorkflowSubscriptionPipeBind</command:parameterValue> <dev:type> <maml:name>WorkflowSubscriptionPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Start-PnPWorkflowInstance -Subscription $subscription -ListItem $item </dev:code> <maml:remarks> <maml:para>Starts a workflow instance on the specified list item</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Start-PnPWorkflowInstance -Subscription $subscription -ListItem 2 </dev:code> <maml:remarks> <maml:para>Starts a workflow instance on the specified list item</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-PnPWorkflowInstance</command:name> <maml:description> <maml:para>Stops a workflow instance</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>PnPWorkflowInstance</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Stop-PnPWorkflowInstance</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The instance to stop</maml:para> </maml:description> <command:parameterValue required="true">WorkflowInstancePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forcefully terminate the workflow instead of cancelling. Works on errored and non-responsive workflows. Deletes all created tasks. Does not notify participants.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forcefully terminate the workflow instead of cancelling. Works on errored and non-responsive workflows. Deletes all created tasks. Does not notify participants.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The instance to stop</maml:para> </maml:description> <command:parameterValue required="true">WorkflowInstancePipeBind</command:parameterValue> <dev:type> <maml:name>WorkflowInstancePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Stop-PnPWorkflowInstance -identity $wfInstance</dev:code> <maml:remarks> <maml:para>Stops the workflow Instance</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Submit-PnPSearchQuery</command:name> <maml:description> <maml:para>Executes an arbitrary search query against the SharePoint search index</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Submit</command:verb> <command:noun>PnPSearchQuery</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Submit-PnPSearchQuery</maml:name> <command:parameter required="true" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>Search query in Keyword Query Language (KQL).</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartRow</maml:name> <maml:description> <maml:para>Search result item to start returning the results from. Useful for paging. Leave at 0 to return all results.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Maximum amount of search results to return. Default and max per page is 500 search results.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TrimDuplicates</maml:name> <maml:description> <maml:para>Specifies whether near duplicate items should be removed from the search results.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Properties</maml:name> <maml:description> <maml:para>Extra query properties. Can for example be used for Office Graph queries.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refiners</maml:name> <maml:description> <maml:para>The list of refiners to be returned in a search result.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Culture</maml:name> <maml:description> <maml:para>The locale for the query.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>QueryTemplate</maml:name> <maml:description> <maml:para>Specifies the query template that is used at run time to transform the query based on user input.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SelectProperties</maml:name> <maml:description> <maml:para>The list of properties to return in the search results.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RefinementFilters</maml:name> <maml:description> <maml:para>The set of refinement filters used.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SortList</maml:name> <maml:description> <maml:para>The list of properties by which the search results are ordered.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RankingModelId</maml:name> <maml:description> <maml:para>The identifier (ID) of the ranking model to use for the query.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientType</maml:name> <maml:description> <maml:para>Specifies the name of the client which issued the query.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CollapseSpecification</maml:name> <maml:description> <maml:para>Limit the number of items per the collapse specification. See https://docs.microsoft.com/en-us/sharepoint/dev/general-development/customizing-search-results-in-sharepoint#collapse-similar-search-results-using-the-collapsespecification-property for more information.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HiddenConstraints</maml:name> <maml:description> <maml:para>The keyword query’s hidden constraints.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TimeZoneId</maml:name> <maml:description> <maml:para>The identifier for the search query time zone.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnablePhonetic</maml:name> <maml:description> <maml:para>Specifies whether the phonetic forms of the query terms are used to find matches.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableStemming</maml:name> <maml:description> <maml:para>Specifies whether stemming is enabled.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableQueryRules</maml:name> <maml:description> <maml:para>Specifies whether Query Rules are enabled for this query.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the identifier (ID or name) of the result source to be used to run the query.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProcessBestBets</maml:name> <maml:description> <maml:para>Determines whether Best Bets are enabled.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProcessPersonalFavorites</maml:name> <maml:description> <maml:para>Determines whether personal favorites data is processed or not.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RelevantResults</maml:name> <maml:description> <maml:para>Specifies whether only relevant results are returned</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Submit-PnPSearchQuery</maml:name> <command:parameter required="true" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>Search query in Keyword Query Language (KQL).</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Automatically page results until the end to get more than 500. Use with caution!</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TrimDuplicates</maml:name> <maml:description> <maml:para>Specifies whether near duplicate items should be removed from the search results.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Properties</maml:name> <maml:description> <maml:para>Extra query properties. Can for example be used for Office Graph queries.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refiners</maml:name> <maml:description> <maml:para>The list of refiners to be returned in a search result.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Culture</maml:name> <maml:description> <maml:para>The locale for the query.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>QueryTemplate</maml:name> <maml:description> <maml:para>Specifies the query template that is used at run time to transform the query based on user input.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SelectProperties</maml:name> <maml:description> <maml:para>The list of properties to return in the search results.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RefinementFilters</maml:name> <maml:description> <maml:para>The set of refinement filters used.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SortList</maml:name> <maml:description> <maml:para>The list of properties by which the search results are ordered.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RankingModelId</maml:name> <maml:description> <maml:para>The identifier (ID) of the ranking model to use for the query.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientType</maml:name> <maml:description> <maml:para>Specifies the name of the client which issued the query.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CollapseSpecification</maml:name> <maml:description> <maml:para>Limit the number of items per the collapse specification. See https://docs.microsoft.com/en-us/sharepoint/dev/general-development/customizing-search-results-in-sharepoint#collapse-similar-search-results-using-the-collapsespecification-property for more information.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HiddenConstraints</maml:name> <maml:description> <maml:para>The keyword query’s hidden constraints.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TimeZoneId</maml:name> <maml:description> <maml:para>The identifier for the search query time zone.</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnablePhonetic</maml:name> <maml:description> <maml:para>Specifies whether the phonetic forms of the query terms are used to find matches.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableStemming</maml:name> <maml:description> <maml:para>Specifies whether stemming is enabled.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableQueryRules</maml:name> <maml:description> <maml:para>Specifies whether Query Rules are enabled for this query.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the identifier (ID or name) of the result source to be used to run the query.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProcessBestBets</maml:name> <maml:description> <maml:para>Determines whether Best Bets are enabled.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProcessPersonalFavorites</maml:name> <maml:description> <maml:para>Determines whether personal favorites data is processed or not.</maml:para> </maml:description> <command:parameterValue required="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RelevantResults</maml:name> <maml:description> <maml:para>Specifies whether only relevant results are returned</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>All</maml:name> <maml:description> <maml:para>Automatically page results until the end to get more than 500. Use with caution!</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ClientType</maml:name> <maml:description> <maml:para>Specifies the name of the client which issued the query.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>CollapseSpecification</maml:name> <maml:description> <maml:para>Limit the number of items per the collapse specification. See https://docs.microsoft.com/en-us/sharepoint/dev/general-development/customizing-search-results-in-sharepoint#collapse-similar-search-results-using-the-collapsespecification-property for more information.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Culture</maml:name> <maml:description> <maml:para>The locale for the query.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnablePhonetic</maml:name> <maml:description> <maml:para>Specifies whether the phonetic forms of the query terms are used to find matches.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableQueryRules</maml:name> <maml:description> <maml:para>Specifies whether Query Rules are enabled for this query.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>EnableStemming</maml:name> <maml:description> <maml:para>Specifies whether stemming is enabled.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HiddenConstraints</maml:name> <maml:description> <maml:para>The keyword query’s hidden constraints.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>Maximum amount of search results to return. Default and max per page is 500 search results.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProcessBestBets</maml:name> <maml:description> <maml:para>Determines whether Best Bets are enabled.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>ProcessPersonalFavorites</maml:name> <maml:description> <maml:para>Determines whether personal favorites data is processed or not.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Properties</maml:name> <maml:description> <maml:para>Extra query properties. Can for example be used for Office Graph queries.</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>Search query in Keyword Query Language (KQL).</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>QueryTemplate</maml:name> <maml:description> <maml:para>Specifies the query template that is used at run time to transform the query based on user input.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RankingModelId</maml:name> <maml:description> <maml:para>The identifier (ID) of the ranking model to use for the query.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RefinementFilters</maml:name> <maml:description> <maml:para>The set of refinement filters used.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Refiners</maml:name> <maml:description> <maml:para>The list of refiners to be returned in a search result.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>RelevantResults</maml:name> <maml:description> <maml:para>Specifies whether only relevant results are returned</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SelectProperties</maml:name> <maml:description> <maml:para>The list of properties to return in the search results.</maml:para> </maml:description> <command:parameterValue required="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SortList</maml:name> <maml:description> <maml:para>The list of properties by which the search results are ordered.</maml:para> </maml:description> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>Specifies the identifier (ID or name) of the result source to be used to run the query.</maml:para> </maml:description> <command:parameterValue required="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>StartRow</maml:name> <maml:description> <maml:para>Search result item to start returning the results from. Useful for paging. Leave at 0 to return all results.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TimeZoneId</maml:name> <maml:description> <maml:para>The identifier for the search query time zone.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>TrimDuplicates</maml:name> <maml:description> <maml:para>Specifies whether near duplicate items should be removed from the search results.</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<System.Object></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Submit-PnPSearchQuery -Query "finance"</dev:code> <maml:remarks> <maml:para>Returns the top 500 items with the term finance</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Submit-PnPSearchQuery -Query "Title:Intranet*" -MaxResults 10</dev:code> <maml:remarks> <maml:para>Returns the top 10 items indexed by SharePoint Search of which the title starts with the word Intranet</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Submit-PnPSearchQuery -Query "Title:Intranet*" -All</dev:code> <maml:remarks> <maml:para>Returns absolutely all items indexed by SharePoint Search of which the title starts with the word Intranet</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 4---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Submit-PnPSearchQuery -Query "Title:Intranet*" -Refiners "contentclass,FileType(filter=6/0/*)"</dev:code> <maml:remarks> <maml:para>Returns absolutely all items indexed by SharePoint Search of which the title starts with the word Intranet, and return refiners for contentclass and FileType managed properties</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Sync-PnPAppToTeams</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Synchronize an app from the tenant app catalog to the Microsoft Teams app catalog</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Sync</command:verb> <command:noun>PnPAppToTeams</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Sync-PnPAppToTeams</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the Addin Instance</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the Addin Instance</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> <dev:type> <maml:name>AppMetadataPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Sync-PnPAppToTeams -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>This will synchronize the given app with the Microsoft Teams app catalog</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-PnPListItemIsRecord</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Checks if a list item is a record</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>PnPListItemIsRecord</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Test-PnPListItemIsRecord</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object</maml:para> </maml:description> <command:parameterValue required="true">ListItemPipeBind</command:parameterValue> <dev:type> <maml:name>ListItemPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true">ListPipeBind</command:parameterValue> <dev:type> <maml:name>ListPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Test-PnPListItemIsRecord -List "Documents" -Identity 4</dev:code> <maml:remarks> <maml:para>Returns true if the document in the documents library with id 4 is a record</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-PnPTenantTemplate</command:name> <maml:description> <maml:para>Tests a tenant template for invalid references</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>PnPTenantTemplate</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Test-PnPTenantTemplate</maml:name> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The in-memory template to test</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningHierarchy</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>The in-memory template to test</maml:para> </maml:description> <command:parameterValue required="true">ProvisioningHierarchy</command:parameterValue> <dev:type> <maml:name>ProvisioningHierarchy</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Test-PnPTenantTemplate -Template $myTemplate</dev:code> <maml:remarks> <maml:para>Checks for valid template references</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Uninstall-PnPApp</command:name> <maml:description> <maml:para>Uninstalls an available add-in from the site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Uninstall</command:verb> <command:noun>PnPApp</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Uninstall-PnPApp</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the Addin Instance</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="true">AppCatalogScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the Addin Instance</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> <dev:type> <maml:name>AppMetadataPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="false">AppCatalogScope</command:parameterValue> <dev:type> <maml:name>AppCatalogScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Uninstall-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>This will uninstall the specified app from the current site.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Uninstall-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site</dev:code> <maml:remarks> <maml:para>This will uninstall the specified app from the current site. Notice that the app was original installed from the site collection appcatalog.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Uninstall-PnPAppInstance</command:name> <maml:description> <maml:para>Removes an app from a site</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Uninstall</command:verb> <command:noun>PnPAppInstance</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes an add-in/app that has been installed to a site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Uninstall-PnPAppInstance</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Appinstance or Id of the addin to remove.</maml:para> </maml:description> <command:parameterValue required="true">AppPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not ask for confirmation.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Appinstance or Id of the addin to remove.</maml:para> </maml:description> <command:parameterValue required="true">AppPipeBind</command:parameterValue> <dev:type> <maml:name>AppPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="false">WebPipeBind</command:parameterValue> <dev:type> <maml:name>WebPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Uninstall-PnPAppInstance -Identity $appinstance</dev:code> <maml:remarks> <maml:para>Uninstalls the app instance which was retrieved with the command Get-PnPAppInstance</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Uninstall-PnPAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>Uninstalls the app instance with the ID '99a00f6e-fb81-4dc7-8eac-e09c6f9132fe'</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Uninstall-PnPAppInstance -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -force</dev:code> <maml:remarks> <maml:para>Uninstalls the app instance with the ID '99a00f6e-fb81-4dc7-8eac-e09c6f9132fe' and do not ask for confirmation</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Uninstall-PnPSolution</command:name> <maml:description> <maml:para>Uninstalls a sandboxed solution from a site collection</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Uninstall</command:verb> <command:noun>PnPSolution</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Uninstall-PnPSolution</maml:name> <command:parameter required="true" position="named"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>ID of the solution, from the solution manifest</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PackageName</maml:name> <maml:description> <maml:para>Filename of the WSP file to uninstall</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MajorVersion</maml:name> <maml:description> <maml:para>Optional major version of the solution, defaults to 1</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinorVersion</maml:name> <maml:description> <maml:para>Optional minor version of the solution, defaults to 0</maml:para> </maml:description> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>MajorVersion</maml:name> <maml:description> <maml:para>Optional major version of the solution, defaults to 1</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>MinorVersion</maml:name> <maml:description> <maml:para>Optional minor version of the solution, defaults to 0</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>ID of the solution, from the solution manifest</maml:para> </maml:description> <command:parameterValue required="true">GuidPipeBind</command:parameterValue> <dev:type> <maml:name>GuidPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>PackageName</maml:name> <maml:description> <maml:para>Filename of the WSP file to uninstall</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Uninstall-PnPSolution -PackageId c2f5b025-7c42-4d3a-b579-41da3b8e7254 -PackageName mypackage.wsp</dev:code> <maml:remarks> <maml:para>Removes the package to the current site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Unpublish-PnPApp</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Unpublishes/retracts an available add-in from the app catalog</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Unpublish</command:verb> <command:noun>PnPApp</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Unpublish-PnPApp</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the Addin Instance</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="true">AppCatalogScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of the Addin Instance</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> <dev:type> <maml:name>AppMetadataPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="false">AppCatalogScope</command:parameterValue> <dev:type> <maml:name>AppCatalogScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Unpublish-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>This will retract, but not remove, the specified app from the tenant app catalog</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Unpublish-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site</dev:code> <maml:remarks> <maml:para>This will retract, but not remove, the specified app from the site collection app catalog</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Unregister-PnPHubSite</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Unregisters a site as a hubsite</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Unregister</command:verb> <command:noun>PnPHubSite</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Registers a site as a hubsite</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-PnPHubSite</maml:name> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to unregister as a hubsite</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to unregister as a hubsite</maml:para> </maml:description> <command:parameterValue required="true">SitePipeBind</command:parameterValue> <dev:type> <maml:name>SitePipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Unregister-PnPHubSite -Site https://tenant.sharepoint.com/sites/myhubsite</dev:code> <maml:remarks> <maml:para>This example unregisters the specified site as a hubsite</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Update-PnPApp</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online, SharePoint 2019. Updates an available app from the app catalog</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>PnPApp</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Update-PnPApp</maml:name> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id or an actual app metadata instance</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="true">AppCatalogScope</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SPOnlineConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="named"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id or an actual app metadata instance</maml:para> </maml:description> <command:parameterValue required="true">AppMetadataPipeBind</command:parameterValue> <dev:type> <maml:name>AppMetadataPipeBind</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="false">AppCatalogScope</command:parameterValue> <dev:type> <maml:name>AppCatalogScope</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="false">SPOnlineConnection</command:parameterValue> <dev:type> <maml:name>SPOnlineConnection</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Update-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe</dev:code> <maml:remarks> <maml:para>This will update an already installed app if a new version is available in the tenant app catalog. Retrieve a list all available apps and the installed and available versions with Get-PnPApp</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Update-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site</dev:code> <maml:remarks> <maml:para>This will update an already installed app if a new version is available in the site collection app catalog. Retrieve a list all available apps and the installed and available versions with Get-PnPApp -Scope Site</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Update-PnPSiteClassification</command:name> <maml:description> <maml:para>* Supported in: SharePoint Online. Updates Site Classifications for the tenant. Requires a connection to the Microsoft Graph.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>PnPSiteClassification</command:noun> <dev:version /> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Update-PnPSiteClassification</maml:name> <command:parameter required="false" position="named"> <maml:name>Classifications</maml:name> <maml:description> <maml:para>A list of classifications, separated by commas. E.g. "HBI","LBI","Top Secret"</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultClassification</maml:name> <maml:description> <maml:para>The default classification to be used. The value needs to be present in the list of possible classifications</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsageGuidelinesUrl</maml:name> <maml:description> <maml:para>The UsageGuidelinesUrl. Set to "" to clear.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-PnPSiteClassification</maml:name> <command:parameter required="true" position="named"> <maml:name>Settings</maml:name> <maml:description> <maml:para>A settings object retrieved by Get-PnPSiteClassification</maml:para> </maml:description> <command:parameterValue required="true">SiteClassificationsSettings</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named"> <maml:name>Classifications</maml:name> <maml:description> <maml:para>A list of classifications, separated by commas. E.g. "HBI","LBI","Top Secret"</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>DefaultClassification</maml:name> <maml:description> <maml:para>The default classification to be used. The value needs to be present in the list of possible classifications</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" position="named"> <maml:name>Settings</maml:name> <maml:description> <maml:para>A settings object retrieved by Get-PnPSiteClassification</maml:para> </maml:description> <command:parameterValue required="true">SiteClassificationsSettings</command:parameterValue> <dev:type> <maml:name>SiteClassificationsSettings</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>UsageGuidelinesUrl</maml:name> <maml:description> <maml:para>The UsageGuidelinesUrl. Set to "" to clear.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>------------------EXAMPLE 1---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" PS:> Update-PnPSiteClassification -Classifications "HBI","Top Secret"</dev:code> <maml:remarks> <maml:para>Replaces the existing values of the site classification settings</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" PS:> Update-PnPSiteClassification -DefaultClassification "LBI"</dev:code> <maml:remarks> <maml:para>Sets the default classification value to "LBI". This value needs to be present in the list of classification values.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>------------------EXAMPLE 3---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Scopes "Directory.ReadWrite.All" PS:> Update-PnPSiteClassification -UsageGuidelinesUrl https://aka.ms/sppnp</dev:code> <maml:remarks> <maml:para>sets the usage guideliness URL to the specified URL.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |