SharePointPnP.PowerShell.2016.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-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>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="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.</maml:para> <maml:para></maml:para> </maml:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <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://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.usercustomaction.aspx</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>BasePermissions:</maml:linkText> <maml:uri>https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.basepermissions.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-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 to a list in 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: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 to a list in 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>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>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>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="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 -FileName 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 -FileName 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 -FileName 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-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</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>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing 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="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:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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>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.</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.</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.</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.</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-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-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-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:syntax> <command:parameters> <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>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml: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>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing 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>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:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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>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.</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>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.</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.</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>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:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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>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-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>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>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml: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>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 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>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>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>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>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 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>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 Add-In Registration in SharePoint. Used as the HighTrustCertificateIssuerId if none is specified.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>HighTrustCertificate</maml:name> <maml:description> <maml:para>The certificate which has been registered in SharePoint as a Trusted Security Token issuer to use for the High Trust connection. Note that CNG key storage providers are not supported.</maml:para> </maml:description> <command:parameterValue required="true">X509Certificate2</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>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>HighTrustCertificateIssuerId</maml:name> <maml:description> <maml:para>The IssuerID under which the certificate has been registered in SharePoint as a Trusted Security Token issuer to use for the High Trust connection. Uses the ClientID if not specified.</maml:para> </maml:description> <command:parameterValue required="true">String</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 Add-In Registration in SharePoint. Used as the HighTrustCertificateIssuerId if none is specified.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>HighTrustCertificatePath</maml:name> <maml:description> <maml:para>The path to the private key certificate (.pfx) to use for the High Trust connection</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named"> <maml:name>HighTrustCertificatePassword</maml:name> <maml:description> <maml:para>The password of the private key certificate (.pfx) to use for the High Trust connection</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>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>HighTrustCertificateIssuerId</maml:name> <maml:description> <maml:para>The IssuerID under which the CER counterpart of the PFX has been registered in SharePoint as a Trusted Security Token issuer to use for the High Trust connection. Uses the ClientID if not specified.</maml:para> </maml:description> <command:parameterValue required="true">String</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>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="true" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The Client ID of the Add-In Registration in SharePoint. Used as the HighTrustCertificateIssuerId if none is specified.</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 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>HighTrustCertificate</maml:name> <maml:description> <maml:para>The certificate which has been registered in SharePoint as a Trusted Security Token issuer to use for the High Trust connection. Note that CNG key storage providers are not supported.</maml:para> </maml:description> <command:parameterValue required="true">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" position="named"> <maml:name>HighTrustCertificateIssuerId</maml:name> <maml:description> <maml:para>The IssuerID under which the certificate has been registered in SharePoint as a Trusted Security Token issuer to use for the High Trust connection. Uses the ClientID if not 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>HighTrustCertificatePassword</maml:name> <maml:description> <maml:para>The password of the private key certificate (.pfx) to use for the High Trust connection</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>HighTrustCertificatePath</maml:name> <maml:description> <maml:para>The path to the private key certificate (.pfx) to use for the High Trust connection</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>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>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="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="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>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="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>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="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 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 7---------------------</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 8---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> certutil.exe -csp 'Microsoft Enhanced RSA and AES Cryptographic Provider' -v -p 'password' -importpfx -user c:\HighTrust.pfx NoRoot PS:> Connect-PnPOnline -Url https://yourserver -ClientId <id> -HighTrustCertificate (Get-Item Cert:\CurrentUser\My\<thumbprint>)</dev:code> <maml:remarks> <maml:para>Connect to an on-premises SharePoint environment using a high trust certificate, stored in the Personal certificate store of 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 9---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPOnline -Url https://yourserver -ClientId 763d5e60-b57e-426e-8e87-b7258f7f8188 -HighTrustCertificatePath c:\HighTrust.pfx -HighTrustCertificatePassword 'password' -HighTrustCertificateIssuerId 6b9534d8-c2c1-49d6-9f4b-cd415620bca8</dev:code> <maml:remarks> <maml:para>Connect to an on-premises SharePoint environment using a high trust certificate stored in a .PFX 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>Connect-PnPMicrosoftGraph</command:name> <maml:description> <maml:para>Connect to the Microsoft Graph</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>PnPMicrosoftGraph</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Uses the Microsoft Authentication Library (Preview) to connect to Azure AD and to get an OAuth 2.0 Access Token to consume the Microsoft Graph API</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-PnPMicrosoftGraph</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:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPMicrosoftGraph</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: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>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> <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 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> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> </command:parameter> <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> <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-PnPMicrosoftGraph -Scopes $arrayOfScopes</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://graph.microsoft.io/en-us/docs/authorization/permission_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 2---------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS:> Connect-PnPMicrosoftGraph -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:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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>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>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>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-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>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-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 -TermSet 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 -TermSet 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-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-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-PnPAzureADManifestKeyCredentials</command:name> <maml:description> <maml:para>Return the JSON Manifest snippet for Azure Apps</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPAzureADManifestKeyCredentials</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates the JSON snippet that is required for the manifest JSON file for Azure WebApplication / WebAPI apps</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureADManifestKeyCredentials</maml:name> <command:parameter required="true" position="named"> <maml:name>CertPath</maml:name> <maml:description> <maml:para>Specifies the path to the certificate like .\mycert.cer</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>CertPath</maml:name> <maml:description> <maml:para>Specifies the path to the certificate like .\mycert.cer</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>System.String</maml:name> <maml:uri /> <maml:description> <maml:para>Outputs a JSON formatted string</maml:para> </maml:description> </dev: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-PnPAzureADManifestKeyCredentials -CertPath .\mycert.cer</dev:code> <maml:remarks> <maml:para>Output the JSON snippet which needs to be replaced in the application manifest 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:> Get-PnPAzureADManifestKeyCredentials -CertPath .\mycert.cer | Set-Clipboard</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-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-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>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection 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>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. Use Ensure-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="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>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>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:examples> <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>Ensure-PnPFolder:</maml:linkText> <maml:uri>https://github.com/OfficeDev/PnP-PowerShell/blob/master/Documentation/EnsureSPOFolder.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 folder to retrieve</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>FolderSiteRelativeUrl</maml:name> <maml:description> <maml:para>The site relative 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>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="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml: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:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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>Retrieves the healthscore value.</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-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-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-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-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-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-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>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>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>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>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>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:examples> <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>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection 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>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection 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>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:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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</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>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing 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>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 for site content 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:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-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-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-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:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-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:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-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</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-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 the users that exist in the current site collection its 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>* Supported in: . </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PnPUserProfileProperty</command:noun> <dev:version /> </command:details> <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></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev: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-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-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>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-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-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-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-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>New-PnPExtensibilityHandlerObject</command:name> <maml:description> <maml:para>Creates an ExtensibilityHandler Object, to be used by the Get-SPOProvisioningTemplate 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 "DemoList" -Template Announcements</dev:code> <maml:remarks> <maml:para>Create a 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-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>Out</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="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>Out</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</dev:code> <maml:remarks> <maml:para>This will generate a default self-signed certificate named "pnp.contoso.com" valid for 10 years.</maml: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)</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-PnPTenantSite</command:name> <maml:description> <maml:para>Creates a new 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>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>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-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-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-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>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>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-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-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-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-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-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-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)</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-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>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>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-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>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>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>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 -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>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 -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="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>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>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-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-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-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-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-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-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>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>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>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>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>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing 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="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 @{"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:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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</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>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection 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>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection 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>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing 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="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-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-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-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-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-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>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:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev: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</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-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>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>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:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Developer Patterns and Practices:</maml:linkText> <maml:uri>http://aka.ms/sppnp</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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 -SiteLogoPath</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>Web</maml:name> <maml:description> <maml:para>This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.</maml:para> </maml:description> <command:parameterValue required="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing 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>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 -SiteLogoPath</maml:para> </maml: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-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-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 -Name 'WorkflowName' -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 -Name 'WorkflowName' -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>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 -SourceFilePath 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> </helpItems> |