PnP.PowerShell-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" schema="maml" xmlns="http://msh"> <command:command> <command:details> <command:name>Add-PnPAlert</command:name> <maml:description> <maml:para>Adds an alert for a user to a list</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPAlert</command:noun> </command:details> <maml:description> <maml:para>This cmdlets allows to add an alert for a user to a list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPAlert</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AlertTemplateName</maml:name> <maml:description> <maml:para>To define a particular alert template. Refer this [link](https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/bb802738(v=office.14)) to specify the template value name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ChangeType</maml:name> <maml:description> <maml:para>Alert change type</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AlertEventType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DeliveryMethod</maml:name> <maml:description> <maml:para>Alert delivery method</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AlertDeliveryChannel</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Alert filter</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AlertFilter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Frequency</maml:name> <maml:description> <maml:para>Alert frequency</maml:para> <maml:para>For daily: Use the -Time parameter to specify the time of the day the alert should be sent out. I.e. pass in -Time (Get-Date -Hour 11 -Minute 00 -Second 00) to have the alerts sent every day at 11 AM.</maml:para> <maml:para>For weekly: It will take the date and time you pass in and make that the day and time of the week to send out the alert. I.e. if today is a Friday at it is 5.00 PM and you provide (Get-Date).AddDays(1), it will schedule the alert to be sent out on Saturdays at 5.00 PM. Through the web interface of SharePoint Online, the date and time shown with the alert will be converted to its equivalent in PST (Redmond time zone), regardless of the region configuration of the site.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AlertFrequency</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Time</maml:name> <maml:description> <maml:para>Alert time (if frequency is not immediate). See additional notes on how to use this parameter under -Frequency.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Alert title</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User to create the alert for (User ID, login name or actual User object). Skip this parameter to create an alert for the current user. Note: Only site owners can create alerts for other users.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">UserPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AlertTemplateName</maml:name> <maml:description> <maml:para>To define a particular alert template. Refer this [link](https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/bb802738(v=office.14)) to specify the template value name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ChangeType</maml:name> <maml:description> <maml:para>Alert change type</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AlertEventType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DeliveryMethod</maml:name> <maml:description> <maml:para>Alert delivery method</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AlertDeliveryChannel</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Alert filter</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AlertFilter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Frequency</maml:name> <maml:description> <maml:para>Alert frequency</maml:para> <maml:para>For daily: Use the -Time parameter to specify the time of the day the alert should be sent out. I.e. pass in -Time (Get-Date -Hour 11 -Minute 00 -Second 00) to have the alerts sent every day at 11 AM.</maml:para> <maml:para>For weekly: It will take the date and time you pass in and make that the day and time of the week to send out the alert. I.e. if today is a Friday at it is 5.00 PM and you provide (Get-Date).AddDays(1), it will schedule the alert to be sent out on Saturdays at 5.00 PM. Through the web interface of SharePoint Online, the date and time shown with the alert will be converted to its equivalent in PST (Redmond time zone), regardless of the region configuration of the site.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AlertFrequency</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Time</maml:name> <maml:description> <maml:para>Alert time (if frequency is not immediate). See additional notes on how to use this parameter under -Frequency.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Alert title</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User to create the alert for (User ID, login name or actual User object). Skip this parameter to create an alert for the current user. Note: Only site owners can create alerts for other users.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">UserPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAlert -List "Demo List" ```</maml:para> <maml:para>Adds a new alert to the "Demo List" for the current user.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAlert -Title "Daily summary" -List "Demo List" -Frequency Daily -ChangeType All -Time (Get-Date -Hour 11 -Minute 00 -Second 00) ```</maml:para> <maml:para>Adds a daily alert for the current user at the given time to the "Demo List". Note: a timezone offset might be applied so please verify on your tenant that the alert indeed got the right time.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAlert -Title "Alert for user" -List "Demo List" -User "i:0#.f|membership|Alice@contoso.onmicrosoft.com" ```</maml:para> <maml:para>Adds a new alert for user "Alice" to the "Demo List". Note: Only site owners and admins are permitted to set alerts for other users.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAlert -Title "Alert for user" -List "Demo List" -User "i:0#.f|membership|Alice@contoso.onmicrosoft.com" -Frequency Daily -Time ((Get-Date).AddDays(1)) ```</maml:para> <maml:para>Adds a new weekly alert for user "Alice" to the "Demo List". The moment the alert will be sent out is based on the Date passed in through -Time. It will take the date and time you pass in and make that the day and time of the week to send out the alert. I.e. if today is a Friday at it is 5.00 PM and you provide (Get-Date).AddDays(1), it will schedule the alert to be sent out on Saturdays at 5.00 PM. Through the web interface of SharePoint Online, the date and time shown with the alert will be converted to its equivalent in PST (Redmond time zone), regardless of the region configuration of the site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPApp</command:name> <maml:description> <maml:para>Add/uploads an available app to the app catalog</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPApp</command:noun> </command:details> <maml:description> <maml:para>Allows to upload an app to the app catalog at tenant or site collection level. By specifying `-Publish` option it is possible to deploy/trust it at the same time.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPApp</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to change no-script setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When provided, it will overwrite the existing app package if it already exists</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the app package to deploy to the App Catalog</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Publish</maml:name> <maml:description> <maml:para>This will deploy/trust an app into the App Catalog</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use: the site collection scoped App Catalog or the tenant wide App Catalog. Defaults to Tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AppCatalogScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipFeatureDeployment</maml:name> <maml:description> <maml:para>When provided, the solution will be globally deployed, meaning one does not have to go into every site to add it as an app to have its components available. Instead they will be available rightaway.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the timeout in seconds. Defaults to 200.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to change no-script setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When provided, it will overwrite the existing app package if it already exists</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the app package to deploy to the App Catalog</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Publish</maml:name> <maml:description> <maml:para>This will deploy/trust an app into the App Catalog</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use: the site collection scoped App Catalog or the tenant wide App Catalog. Defaults to Tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AppCatalogScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipFeatureDeployment</maml:name> <maml:description> <maml:para>When provided, the solution will be globally deployed, meaning one does not have to go into every site to add it as an app to have its components available. Instead they will be available rightaway.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the timeout in seconds. Defaults to 200.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPApp -Path ./myapp.sppkg ```</maml:para> <maml:para>This will upload the specified app package to the tenant app catalog</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPApp -Path ./myapp.sppkg -Publish ```</maml:para> <maml:para>This will upload the specified app package to the tenant app catalog and deploy/trust it at the same time.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPApp -Path ./myapp.sppkg -Scope Site -Publish ```</maml:para> <maml:para>This will upload the specified app package to the site collection app catalog and deploy/trust it at the same time.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPApp -Path ./myapp.sppkg -Publish -SkipFeatureDeployment ```</maml:para> <maml:para>This will upload the specified app package to the tenant app catalog, deploy/trust it and make it globally available on all site collections.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPApplicationCustomizer</command:name> <maml:description> <maml:para>Adds a SharePoint Framework client side extension application customizer to a specific site collection or web</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPApplicationCustomizer</command:noun> </command:details> <maml:description> <maml:para>Adds a SharePoint Framework client side extension application customizer by registering a user custom action to a web or sitecollection. This can be useful in the scenario where you have a SPFx Application Customizer whcih you decide to deploy to the global app catalog, checking the box to deploy it to the entire tenant. If you then go to the Tenant Wide Extensions list inside the tenant app catalog and set the SPFx Application Customizer its Disabled property to be Yes, you can use this cmdlet to add the functionality of that SPFx component to specific site collections manually. This voids having to add it as an app to every site collection and it being visible in the site contents, yet you having full control over where it should be ran and where not.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPApplicationCustomizer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties of the application customizer. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideHostProperties</maml:name> <maml:description> <maml:para>The Client Side Host Properties of the application customizer. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the application customizer</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the application customizer</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this application customizer being injected. Use when you have a specific sequence with which to have multiple application customizers being added to the page.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the application customizer</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties of the application customizer. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideHostProperties</maml:name> <maml:description> <maml:para>The Client Side Host Properties of the application customizer. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the application customizer</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the application customizer</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Sequence of this application customizer being injected. Use when you have a specific sequence with which to have multiple application customizers being added to the page.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the application customizer</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPApplicationCustomizer -Title "CollabFooter" -ClientSideComponentId c0ab3b94-8609-40cf-861e-2a1759170b43 -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"} ```</maml:para> <maml:para>Adds a new application customizer to the current web. This requires that a SharePoint Framework solution has been deployed containing the application customizer specified in its manifest. Be sure to run Install-PnPApp before trying this cmdlet on a site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPAvailableSiteClassification</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Directory.ReadWrite.All Adds one or more classic site classification values to the list of possible values.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPAvailableSiteClassification</command:noun> </command:details> <maml:description> <maml:para>Allows to add classic site classification values.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPAvailableSiteClassification</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Classifications</maml:name> <maml:description> <maml:para>Classic classifications values to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Collections.Generic.List`1[System.String]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Classifications</maml:name> <maml:description> <maml:para>Classic classifications values to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Collections.Generic.List`1[System.String]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAvailableSiteClassification -Classifications "Top Secret" ```</maml:para> <maml:para>Adds the "Top Secret" classification to the already existing classification values.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAvailableSiteClassification -Classifications "Top Secret","HBI" ```</maml:para> <maml:para>Adds the "Top Secret" and the "HBI" classifications to the already existing classification values.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPAzureADGroupMember</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: All of Group.ReadWrite.All, User.ReadWrite.All Adds members to a particular Azure Active Directory Group. This can be a security, distribution or Microsoft 365 group.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPAzureADGroupMember</command:noun> </command:details> <maml:description> <maml:para>Allows to add users to Azure Active Directory Group. This can be a security, distribution or Microsoft 365 group. By specifying `-RemoveExisting` option it is possible to first clear the group of all existing members.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPAzureADGroupMember</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Azure Active Directory group to add members to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RemoveExisting</maml:name> <maml:description> <maml:para>If provided, all existing members will be removed and only those provided through Users will become members.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>The UPN(s) of the user(s) to add to the Azure Active Directory group as a member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Azure Active Directory group to add members to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RemoveExisting</maml:name> <maml:description> <maml:para>If provided, all existing members will be removed and only those provided through Users will become members.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>The UPN(s) of the user(s) to add to the Azure Active Directory group as a member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAzureADGroupMember -Identity "Project Team" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" ```</maml:para> <maml:para>Adds the provided two users as additional members to the Azure Active Directory Group named "Project Team".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAzureADGroupMember -Identity "Project Team" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" -RemoveExisting ```</maml:para> <maml:para>Sets the provided two users as the only members of the Azure Active Directory group named "Project Team" by removing any current existing members first.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAzureADGroupMember -Identity "Project Team" -Users "125eaa87-7b54-41fd-b30f-2adfa68c4afe" ```</maml:para> <maml:para>Sets the provided security group as a member of the Azure Active Directory group name "Project Team".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/group-post-members</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPAzureADGroupOwner</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: All of Group.ReadWrite.All, User.ReadWrite.All Adds users to the owners of an Azure Active Directory group. This can be a security or Microsoft 365 group. Distribution lists are not currently supported by Graph API.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPAzureADGroupOwner</command:noun> </command:details> <maml:description> <maml:para>Allows to add users to owners of an Azure Active Directory Group. This can be a security, distribution or Microsoft 365 group. By specifying `-RemoveExisting` option it is possible to first clear the group of all existing members.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPAzureADGroupOwner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Azure Active Directory group to add owners to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RemoveExisting</maml:name> <maml:description> <maml:para>If provided, all existing members will be removed and only those provided through Users will become members.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>The UPN(s) of the user(s) to add to the Azure Active Directory group as a member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Azure Active Directory group to add owners to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RemoveExisting</maml:name> <maml:description> <maml:para>If provided, all existing members will be removed and only those provided through Users will become members.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>The UPN(s) of the user(s) to add to the Azure Active Directory group as a member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAzureADGroupOwner -Identity "Project Team" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" ```</maml:para> <maml:para>Adds the provided two users as additional owners to the Azure Active Directory group named "Project Team".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAzureADGroupOwner -Identity "Project Team" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" -RemoveExisting ```</maml:para> <maml:para>Sets the provided two users as the only owners of the Azure Active Directory group named "Project Team" by removing any current existing members first.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAzureADGroupOwner -Identity "Project Team" -Users "125eaa87-7b54-41fd-b30f-2adfa68c4afe" ```</maml:para> <maml:para>Sets the provided security group as owner of the Azure Active Directory group name "Project Team".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/group-post-members</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPAzureADServicePrincipalAppRole</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: AppRoleAssignment.ReadWrite.All and Application.Read.All or AppRoleAssignment.ReadWrite.All and Directory.Read.All Adds an app role to a service principal/application registration in Azure Active Directory.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPAzureADServicePrincipalAppRole</command:noun> </command:details> <maml:description> <maml:para>Allows adding of an app role such as Sites.FullControl.All to a service principal/application registration in Azure Active Directory. This can be used to grant permissions to a service principal/application registration, such as a Managed Identity.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPAzureADServicePrincipalAppRole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AppRole</maml:name> <maml:description> <maml:para>The object id, name or instance of the application role to add to the service principal/application registration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServicePrincipalAppRoleBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>BuiltInType</maml:name> <maml:description> <maml:para>The built in application type to use for the app role. This can be MicrosoftGraph or SharePointOnline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServicePrincipalAppRoleBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Principal</maml:name> <maml:description> <maml:para>The object id, name or instance of the service principal/application registration to add the app role to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServicePrincipalPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPAzureADServicePrincipalAppRole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AppRole</maml:name> <maml:description> <maml:para>The object id, name or instance of the application role to add to the service principal/application registration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServicePrincipalAppRoleBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Principal</maml:name> <maml:description> <maml:para>The object id, name or instance of the service principal/application registration to add the app role to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServicePrincipalPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The object id, name or instance of the application to which the role belongs you wish to add to the service principal/application registration. If omitted, it will try to define the owning service principal from the passed in AppRole.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ServicePrincipalAppRoleBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AppRole</maml:name> <maml:description> <maml:para>The object id, name or instance of the application role to add to the service principal/application registration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServicePrincipalAppRoleBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>BuiltInType</maml:name> <maml:description> <maml:para>The built in application type to use for the app role. This can be MicrosoftGraph or SharePointOnline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServicePrincipalAppRoleBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Principal</maml:name> <maml:description> <maml:para>The object id, name or instance of the service principal/application registration to add the app role to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServicePrincipalPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The object id, name or instance of the application to which the role belongs you wish to add to the service principal/application registration. If omitted, it will try to define the owning service principal from the passed in AppRole.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ServicePrincipalAppRoleBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAzureADServicePrincipalAppRole -Principal "62614f96-cb78-4534-bf12-1f6693e8237c" -AppRole "Directory.Read.All" -BuiltInType MicrosoftGraph ```</maml:para> <maml:para>Adds the permission Directory.Read.All for Microsoft Graph to the service principal with the object id 62614f96-cb78-4534-bf12-1f6693e8237c</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipal -BuiltInType SharePointOnline | Get-PnPAzureADServicePrincipalAvailableAppRole -Identity "Sites.FullControl.All" | Add-PnPAzureADServicePrincipalAppRole -Principal "62614f96-cb78-4534-bf12-1f6693e8237c" ```</maml:para> <maml:para>Adds the permission Site.FullControl.All for SharePoint Online to the service principal with the object id 62614f96-cb78-4534-bf12-1f6693e8237c</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipal -BuiltInType MicrosoftGraph | Get-PnPAzureADServicePrincipalAvailableAppRole -Identity "Group.ReadWrite.All" | Add-PnPAzureADServicePrincipalAppRole -Principal "mymanagedidentity" ```</maml:para> <maml:para>Adds the permission Group.ReadWrite.All for Microsoft Graph to the service principal with the name mymanagedidentity.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPAzureADServicePrincipalAppRole -Principal "62614f96-cb78-4534-bf12-1f6693e8237c" -AppRole "MyApplication.Read" -Resource "b8c2a8aa-33a0-43f4-a9d3-fe2851c5293e" ```</maml:para> <maml:para>Adds the permission MyApplication.Read for the application registration with object id b8c2a8aa-33a0-43f4-a9d3-fe2851c5293e to the service principal with the object id 62614f96-cb78-4534-bf12-1f6693e8237c</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/serviceprincipal-post-approleassignments</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPBrandCenterFont</command:name> <maml:description> <maml:para>Allows a font to be uploaded to the tenant Brand Center</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPBrandCenterFont</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows a font to be uploaded to the tenant Brand Center. The font will be available for use in the tenant and site collection Brand Center.</maml:para> <maml:para>Use [Use-PnPBrandCenterFontPackage](Use-PnPBrandCenterFontPackage.md) to apply the font to the current site. Use [Get-PnPBrandCenterFontPackage](Get-PnPBrandCenterFontPackage.md) to retrieve the available fonts.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPBrandCenterFont</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The local file path to where the font is stored that needs to be uploaded</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Visible</maml:name> <maml:description> <maml:para>Indicates if the font should be visible in the Brand Center. The default is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The local file path to where the font is stored that needs to be uploaded</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Visible</maml:name> <maml:description> <maml:para>Indicates if the font should be visible in the Brand Center. The default is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPBrandCenterFont -Path c:\temp\MyAwesomeFont.ttf ```</maml:para> <maml:para>This will upload the font MyAwesomeFont.ttf to the tenant Brand Center and will make it visible</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPBrandCenterFont -Path c:\temp\MyAwesomeFont.ttf -Visible:$false ```</maml:para> <maml:para>This will upload the font MyAwesomeFont.ttf to the tenant Brand Center and will hide it from being used</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPContentType</command:name> <maml:description> <maml:para>Adds a new content type.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPContentType</command:noun> </command:details> <maml:description> <maml:para>Adds a new content type to a site. To create a content type in the modern Content Type Gallery, first connect to the content type hub site for the tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPContentType</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DocumentTemplate</maml:name> <maml:description> <maml:para>Allows providing a server relative path to a file which should be used as the document template for this content type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DocumentTemplate</maml:name> <maml:description> <maml:para>Allows providing a server relative path to a file which should be used as the document template for this content type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentType</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPContentType -Name "Project Document" -Description "Use for Contoso projects" -Group "Contoso Content Types" -ParentContentType $ct ```</maml:para> <maml:para>This will add a new content type based on the parent content type stored in the $ct variable.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPContentType -Name "Project Document" -Description "Use for Contoso projects" -Group "Contoso Content Types" -ParentContentType (Get-PnPContentType -Identity 0x0101) -DocumentTemplate "/_cts/Project Document/template.docx" ```</maml:para> <maml:para>This will add a new content type based on the standard document content type and assigns the document template template.docx to it.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPContentType -Name "Project Item" -Description "Use for Contoso projects" -Group "Contoso Content Types" ```</maml:para> <maml:para>This will add a new content type based on the item content type.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPContentType -Name "Project Item" ```</maml:para> <maml:para>This will add a new content type based on the item content type to a group "Custom Content Types".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPContentType -Name "Project Document" -Description "Use for Contoso projects" -Group "Contoso Content Types" -ContentTypeId 0x010100CD5BDB7DDE03324794E155CE37E4B6BB ```</maml:para> <maml:para>This will add a new content type to a group "Contoso Content Types". The content type will be based on the standard document content type, and with the specified content type id. Mind the content type id format: https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v=office.14)</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPContentTypesFromContentTypeHub</command:name> <maml:description> <maml:para>**Required Permissions** * ManageLists permission on the current site or the content type hub site. Adds published content types from content type hub site to current site. If the content type already exists on the current site then the latest published version of the content type will be synced to the site.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPContentTypesFromContentTypeHub</command:noun> </command:details> <maml:description> <maml:para>Allows to add content types from content type hub site to current site. In case the same content type is already present on the current site then the latest published version will be used.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPContentTypesFromContentTypeHub</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ContentTypes</maml:name> <maml:description> <maml:para>The list of content type ids present in content type hub site that are required to be added/synced to the current site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">List<String></command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to which to add the content types coming from the hub. If omitted, it will be applied to the currently connected site.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ContentTypes</maml:name> <maml:description> <maml:para>The list of content type ids present in content type hub site that are required to be added/synced to the current site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">List<String></command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to which to add the content types coming from the hub. If omitted, it will be applied to the currently connected site.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPContentTypesFromContentTypeHub -ContentTypes "0x0101", "0x01" ```</maml:para> <maml:para>This will add the content types with the ids '0x0101' and '0x01' to the current site. Latest published version of these content types will be synced if they were already present in the current site.</maml:para> <maml:para>- There's an issue with this cmdlet if you use it on private channel sites. The workaround for that is to execute the below command: - `Enable-PnPFeature -Identity 73ef14b1-13a9-416b-a9b5-ececa2b0604c -Scope Site -Force`</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPContentTypesFromContentTypeHub -ContentTypes "0x010057C83E557396744783531D80144BD08D" -Site https://tenant.sharepoint.com/sites/HR ```</maml:para> <maml:para>This will add the content type with the id '0x010057C83E557396744783531D80144BD08D' to the site with the provided URL. Latest published version of these content types will be synced if they were already present in the current site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPContentTypeToDocumentSet</command:name> <maml:description> <maml:para>Adds a content type to a document set.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPContentTypeToDocumentSet</command:noun> </command:details> <maml:description> <maml:para>Allows to add a content type to a document set.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPContentTypeToDocumentSet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">DocumentSetPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">DocumentSetPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPContentTypeToDocumentSet -ContentType "Test CT" -DocumentSet "Test Document Set" ```</maml:para> <maml:para>This will add the content type called 'Test CT' to the document set called 'Test Document Set'.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell $docset = Get-PnPDocumentSetTemplate -Identity "Test Document Set" $ct = Get-PnPContentType -Identity "Test CT" Add-PnPContentTypeToDocumentSet -ContentType $ct -DocumentSet $docset ```</maml:para> <maml:para>This will add the content type called 'Test CT' to the document set called 'Test Document Set'.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPContentTypeToDocumentSet -ContentType 0x0101001F1CEFF1D4126E4CAD10F00B6137E969 -DocumentSet 0x0120D520005DB65D094035A241BAC9AF083F825F3B ```</maml:para> <maml:para>This will add the content type called 'Test CT' to the document set called 'Test Document Set'.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPContentTypeToList</command:name> <maml:description> <maml:para>Adds a new content type to a list</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPContentTypeToList</command:noun> </command:details> <maml:description> <maml:para>Allows to add content type to list. By specifying `-DefaultContentType` option it is possible set the newly added content type as default.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPContentTypeToList</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPContentTypeToList -List "Documents" -ContentType "Project Document" -DefaultContentType ```</maml:para> <maml:para>This will add an existing content type to a list and sets it as the default content type</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPCustomAction</command:name> <maml:description> <maml:para>Adds a custom action</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPCustomAction</command:noun> </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="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the custom action</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the custom action</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">UserCustomActionRegistrationType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">PermissionKind[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the custom action</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPCustomAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the custom action</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties of the custom action. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideHostProperties</maml:name> <maml:description> <maml:para>The Client Side Host Properties of the custom action. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the custom action</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">UserCustomActionRegistrationType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the custom action</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the custom action</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties of the custom action. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideHostProperties</maml:name> <maml:description> <maml:para>The Client Side Host Properties of the custom action. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the custom action</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the custom action</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">UserCustomActionRegistrationType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">PermissionKind[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the custom action</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell $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>"</maml:para> <maml:para>Add-PnPCustomAction -Name 'GetItemsCount' -Title 'Invoke GetItemsCount Action' -Description 'Adds custom action to custom list ribbon' -Group 'SiteActions' -Location 'CommandUI.Ribbon' -CommandUIExtension $cUIExtn ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPCustomAction -Title "CollabFooter" -Name "CollabFooter" -Location "ClientSideExtension.ApplicationCustomizer" -ClientSideComponentId c0ab3b94-8609-40cf-861e-2a1759170b43 -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"}" ```</maml:para> <maml:para>Adds a new application customizer to the site. This requires that an SPFX solution has been deployed containing the application customizer specified. Be sure to run Install-PnPApp before trying this cmdlet on a site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>UserCustomAction</maml:linkText> <command:uri>https://learn.microsoft.com/previous-versions/office/sharepoint-server/ee539583(v=office.15)</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>BasePermissions</maml:linkText> <command:uri>https://learn.microsoft.com/previous-versions/office/sharepoint-server/ee543321(v=office.15)</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPDataRowsToSiteTemplate</command:name> <maml:description> <maml:para>Adds datarows to a list inside a PnP Provisioning Template</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPDataRowsToSiteTemplate</command:noun> </command:details> <maml:description> <maml:para>Allows to add datarows to list inside a PnP Provisioning Template. The command allows to specify the fields which should be retrieved using `-Fields` option and filter the datarows to be used by using `-Query` option.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPDataRowsToSiteTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="none"> <maml:name>IncludeSecurity</maml:name> <maml:description> <maml:para>A switch to include ObjectSecurity information.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <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" variableLength="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="none"> <maml:name>IncludeSecurity</maml:name> <maml:description> <maml:para>A switch to include ObjectSecurity information.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <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" variableLength="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPDataRowsToSiteTemplate -Path template.pnp -List 'PnPTestList' -Fields 'Title','Choice' ```</maml:para> <maml:para>Adds datarows from the provided list to the PnP Provisioning Template at the provided location</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPDataRowsToSiteTemplate -Path template.pnp -List 'PnPTestList' -Query '<Query><Where><Geq><FieldRef Name="Modified"/><Value Type="DateTime"><Today OffsetDays="-7" /></Value></Geq></Where></Query>' -Fields 'Title','Choice' -IncludeSecurity ```</maml:para> <maml:para>Adds datarows from the provided list to the PnP Provisioning Template at the provided location, only the items that have changed since a week ago</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPDocumentSet</command:name> <maml:description> <maml:para>Creates a new document set in a library.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPDocumentSet</command:noun> </command:details> <maml:description> <maml:para>Allows to add new document set to the library.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPDocumentSet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The name of the content type, its ID, or an actual content object referencing the document set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder in the site/list where the document set needs to be created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the document set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The name of the content type, its ID, or an actual content object referencing the document set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder in the site/list where the document set needs to be created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the document set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPDocumentSet -List "Documents" -ContentType "Test Document Set" -Name "Test" ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPDocumentSet -List "Documents" -ContentType "Test Document Set" -Name "Test" -Folder "Documents/Projects/Europe" ```</maml:para> <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' and will be added to the 'Europe' folder, which is located in the 'Projects' folder. Folders will be created if needed.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPEventReceiver</command:name> <maml:description> <maml:para>Adds a new remote event receiver</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPEventReceiver</command:noun> </command:details> <maml:description> <maml:para>This cmdlet adds a new remote event receiver.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPEventReceiver</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EventReceiverType</maml:name> <maml:description> <maml:para>The type of the event receiver like ItemAdded, ItemAdding. See https://learn.microsoft.com/previous-versions/office/sharepoint-server/jj167297(v=office.15) for the full list of available types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EventReceiverType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the remote event receiver</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Synchronization</maml:name> <maml:description> <maml:para>The synchronization type: Asynchronous or Synchronous</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EventReceiverSynchronization</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EventReceiverType</maml:name> <maml:description> <maml:para>The type of the event receiver like ItemAdded, ItemAdding. See https://learn.microsoft.com/previous-versions/office/sharepoint-server/jj167297(v=office.15) for the full list of available types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EventReceiverType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the remote event receiver</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the EventReceiver 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" variableLength="true">EventReceiverScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Synchronization</maml:name> <maml:description> <maml:para>The synchronization type: Asynchronous or Synchronous</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">EventReceiverSynchronization</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPEventReceiver -List "ProjectList" -Name "TestEventReceiver" -Url https://yourserver.azurewebsites.net/eventreceiver.svc -EventReceiverType ItemAdded -Synchronization Asynchronous ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPEventReceiver -Name "TestEventReceiver" -Url https://yourserver.azurewebsites.net/eventreceiver.svc -EventReceiverType WebAdding -Synchronization Synchronous ```</maml:para> <maml:para>This will add a new remote event receiver that is executed before a new subsite is being created</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPEventReceiver -Name "TestEventReceiver" -Url https://yourserver.azurewebsites.net/eventreceiver.svc -EventReceiverType ListAdding -Synchronization Synchronous -Scope Site ```</maml:para> <maml:para>This will add a new remote event receiver that is executed before a new list is being created inside the site collection scope</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPEventReceiver -Name "TestEventReceiver" -Url https://yourserver.azurewebsites.net/eventreceiver.svc -EventReceiverType ListDeleted -Synchronization Asynchronous -Scope Web ```</maml:para> <maml:para>This will add a new remote event receiver that is executed after a list has been deleted from the current site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPField</command:name> <maml:description> <maml:para>Add a field</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPField</command:noun> </command:details> <maml:description> <maml:para>Adds a field (a column) to a list or as a site column. To add a column of type Managed Metadata use the Add-PnPTaxonomyField cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPField</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AddToAllContentTypes</maml:name> <maml:description> <maml:para>Switch Parameter if this field must be added to all content types</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id to set to the field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties to set to the field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>InternalName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the field like Choice, Note, Calculate, MultiChoice. For a complete list of field types visit https://learn.microsoft.com/dotnet/api/microsoft.sharepoint.client.fieldtype</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FieldType</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPField</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FieldPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPField</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AddToAllContentTypes</maml:name> <maml:description> <maml:para>Switch Parameter if this field must be added to all content types</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id to set to the field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties to set to the field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>InternalName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the field like Choice, Note, Calculate, MultiChoice. For a complete list of field types visit https://learn.microsoft.com/dotnet/api/microsoft.sharepoint.client.fieldtype</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FieldType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AddToAllContentTypes</maml:name> <maml:description> <maml:para>Switch Parameter if this field must be added to all content types</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Choices</maml:name> <maml:description> <maml:para>The Choice values when field type is Choice or MultiChoice</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id to set to the field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentProperties</maml:name> <maml:description> <maml:para>The Client Side Component Properties to set to the field</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Formula</maml:name> <maml:description> <maml:para>The Formula when Calculated column is chosen.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>InternalName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the field like Choice, Note, Calculate, MultiChoice. For a complete list of field types visit https://learn.microsoft.com/dotnet/api/microsoft.sharepoint.client.fieldtype</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FieldType</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPField -Type Calculated -InternalName "C1" -DisplayName "C1" -Formula "=[Title]" ```</maml:para> <maml:para>Adds a new calculated site column with the formula specified</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPField -List "Demo list" -DisplayName "Location" -InternalName "SPSLocation" -Type Choice -Group "Demo Group" -AddToDefaultView -Choices "Stockholm","Helsinki","Oslo" ```</maml:para> <maml:para>This will add a field of type Choice to the list "Demo List".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPField -List "Demo list" -DisplayName "Speakers" -InternalName "SPSSpeakers" -Type MultiChoice -Group "Demo Group" -AddToDefaultView -Choices "Obiwan Kenobi","Darth Vader", "Anakin Skywalker" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPField -List "Demo List" -Field "MyTestCol" ```</maml:para> <maml:para>This will add an existing site column called "MyTestCol" to the list "Demo List".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPField -Type Choice -Choices "PnP","Parker","Sharing Is Caring" -DisplayName "My Test Column" -InternalName "MyTestCol" ```</maml:para> <maml:para>This will add a site column of type Choice (only one choice value can be chosen at the same time) called "My Test Column" with three choice values.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPField -Type Calculated -ResultType Number -DisplayName "My Calculated Column" -InternalName "MyCalcCol" -Formula "=Today()" ```</maml:para> <maml:para>This will add a site column of type Calculated called "My Calculated Column" which contains todays date.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Add</command:verb> <command:noun>PnPFieldFromXml</command:noun> </command:details> <maml:description> <maml:para>Allows to add new field by specifying its definition in CAML/XML format to list or site columns.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFieldFromXml</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>FieldXml</maml:name> <maml:description> <maml:para>CAML snippet containing the field definition. See https://learn.microsoft.com/sharepoint/dev/schema/field-element-list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>FieldXml</maml:name> <maml:description> <maml:para>CAML snippet containing the field definition. See https://learn.microsoft.com/sharepoint/dev/schema/field-element-list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell $xml = '<Field Type="Text" Name="PSCmdletTest" DisplayName="PSCmdletTest" ID="{27d81055-f208-41c9-a976-61c5473eed4a}" Group="Test" Required="FALSE" StaticName="PSCmdletTest" />' Add-PnPFieldFromXml -FieldXml $xml ```</maml:para> <maml:para>Adds a field with the specified field CAML code to the site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell $xml = '<Field Type="Text" Name="PSCmdletTest" DisplayName="PSCmdletTest" ID="{27d81055-f208-41c9-a976-61c5473eed4a}" Group="Test" Required="FALSE" StaticName="PSCmdletTest" />' Add-PnPFieldFromXml -List "Demo List" -FieldXml $xml ```</maml:para> <maml:para>Adds a field with the specified field CAML code to the list "Demo List".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Field CAML documentation</maml:linkText> <command:uri>https://learn.microsoft.com/sharepoint/dev/schema/field-element-list</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Add</command:verb> <command:noun>PnPFieldToContentType</command:noun> </command:details> <maml:description> <maml:para>Allows to add a field from site columns to an existing content type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFieldToContentType</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UpdateChildren</maml:name> <maml:description> <maml:para>Specifies whether the field needs to be pushed to child content types. Default value is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UpdateChildren</maml:name> <maml:description> <maml:para>Specifies whether the field needs to be pushed to child content types. Default value is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFieldToContentType -Field "Project_Name" -ContentType "Project Document" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPFile</command:name> <maml:description> <maml:para>Uploads a file to Web</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPFile</command:noun> </command:details> <maml:description> <maml:para>This cmdlet uploads a local file, file from a stream or plain text to the specified folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Approve</maml:name> <maml:description> <maml:para>Will auto approve the uploaded file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ApproveComment</maml:name> <maml:description> <maml:para>The comment added to the approval</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CheckInComment</maml:name> <maml:description> <maml:para>The comment added to the checkin</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CheckinType</maml:name> <maml:description> <maml:para>Specifies the type of check-in for a file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Enum (Microsoft.SharePoint.Client.CheckinType)</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The destination folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>NewFileName</maml:name> <maml:description> <maml:para>Filename to give the file on SharePoint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The local file path</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Will auto publish the file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PublishComment</maml:name> <maml:description> <maml:para>The comment added to the publish action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UseWebDav</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names.</maml:para> <maml:para>Single line of text: -Values @{"Title" = "Title New"}</maml:para> <maml:para>Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"}</maml:para> <maml:para>Rich text: -Values @{"MultiText" = "&lt;strong&gt;New&lt;/strong&gt; text"}</maml:para> <maml:para>Choice: -Values @{"Choice" = "Value 1"}</maml:para> <maml:para>Number: -Values @{"Number" = "10"}</maml:para> <maml:para>Currency: -Values @{"Number" = "10"}</maml:para> <maml:para>Currency: -Values @{"Currency" = "10"}</maml:para> <maml:para>Date and Time: -Values @{"DateAndTime" = "04/20/2023 14:16"} (use mm/dd/yyyy)</maml:para> <maml:para>Lookup (id of lookup value): -Values @{"Lookup" = "2"}</maml:para> <maml:para>Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"}</maml:para> <maml:para>Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2}</maml:para> <maml:para>Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"}</maml:para> <maml:para>Yes/No: -Values @{"YesNo" = $false}</maml:para> <maml:para>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"}</maml:para> <maml:para>Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"}</maml:para> <maml:para>Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term</maml:para> <maml:para>Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"}</maml:para> <maml:para>Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"}</maml:para> <maml:para>Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnP"}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Hashtable</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Approve</maml:name> <maml:description> <maml:para>Will auto approve the uploaded file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ApproveComment</maml:name> <maml:description> <maml:para>The comment added to the approval</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CheckInComment</maml:name> <maml:description> <maml:para>The comment added to the checkin</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CheckinType</maml:name> <maml:description> <maml:para>Specifies the type of check-in for a file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Enum (Microsoft.SharePoint.Client.CheckinType)</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Name for file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The destination folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Will auto publish the file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PublishComment</maml:name> <maml:description> <maml:para>The comment added to the publish action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>Stream with the file contents</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Stream</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UseWebDav</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names.</maml:para> <maml:para>Single line of text: -Values @{"Title" = "Title New"}</maml:para> <maml:para>Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"}</maml:para> <maml:para>Rich text: -Values @{"MultiText" = "&lt;strong&gt;New&lt;/strong&gt; text"}</maml:para> <maml:para>Choice: -Values @{"Choice" = "Value 1"}</maml:para> <maml:para>Number: -Values @{"Number" = "10"}</maml:para> <maml:para>Currency: -Values @{"Number" = "10"}</maml:para> <maml:para>Currency: -Values @{"Currency" = "10"}</maml:para> <maml:para>Date and Time: -Values @{"DateAndTime" = "04/20/2023 14:16"} (use mm/dd/yyyy)</maml:para> <maml:para>Lookup (id of lookup value): -Values @{"Lookup" = "2"}</maml:para> <maml:para>Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"}</maml:para> <maml:para>Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2}</maml:para> <maml:para>Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"}</maml:para> <maml:para>Yes/No: -Values @{"YesNo" = $false}</maml:para> <maml:para>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"}</maml:para> <maml:para>Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"}</maml:para> <maml:para>Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term</maml:para> <maml:para>Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"}</maml:para> <maml:para>Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"}</maml:para> <maml:para>Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnP"}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Hashtable</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Approve</maml:name> <maml:description> <maml:para>Will auto approve the uploaded file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ApproveComment</maml:name> <maml:description> <maml:para>The comment added to the approval</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CheckInComment</maml:name> <maml:description> <maml:para>The comment added to the checkin</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CheckinType</maml:name> <maml:description> <maml:para>Specifies the type of check-in for a file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Enum (Microsoft.SharePoint.Client.CheckinType)</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The destination folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Will auto publish the file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PublishComment</maml:name> <maml:description> <maml:para>The comment added to the publish action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UseWebDav</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names.</maml:para> <maml:para>Single line of text: -Values @{"Title" = "Title New"}</maml:para> <maml:para>Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"}</maml:para> <maml:para>Rich text: -Values @{"MultiText" = "&lt;strong&gt;New&lt;/strong&gt; text"}</maml:para> <maml:para>Choice: -Values @{"Choice" = "Value 1"}</maml:para> <maml:para>Number: -Values @{"Number" = "10"}</maml:para> <maml:para>Currency: -Values @{"Number" = "10"}</maml:para> <maml:para>Currency: -Values @{"Currency" = "10"}</maml:para> <maml:para>Date and Time: -Values @{"DateAndTime" = "04/20/2023 14:16"} (use mm/dd/yyyy)</maml:para> <maml:para>Lookup (id of lookup value): -Values @{"Lookup" = "2"}</maml:para> <maml:para>Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"}</maml:para> <maml:para>Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2}</maml:para> <maml:para>Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"}</maml:para> <maml:para>Yes/No: -Values @{"YesNo" = $false}</maml:para> <maml:para>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"}</maml:para> <maml:para>Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"}</maml:para> <maml:para>Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term</maml:para> <maml:para>Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"}</maml:para> <maml:para>Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"}</maml:para> <maml:para>Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnP"}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Hashtable</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Approve</maml:name> <maml:description> <maml:para>Will auto approve the uploaded file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ApproveComment</maml:name> <maml:description> <maml:para>The comment added to the approval</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CheckInComment</maml:name> <maml:description> <maml:para>The comment added to the checkin</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CheckinType</maml:name> <maml:description> <maml:para>Specifies the type of check-in for a file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Enum (Microsoft.SharePoint.Client.CheckinType)</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Content</maml:name> <maml:description> <maml:para>Content to add to the file to create or overwrite on SharePoint. It will blindly overwrite the contents of the file if it already exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Name for file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The destination folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>NewFileName</maml:name> <maml:description> <maml:para>Filename to give the file on SharePoint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The local file path</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Will auto publish the file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PublishComment</maml:name> <maml:description> <maml:para>The comment added to the publish action</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>Stream with the file contents</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Stream</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UseWebDav</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names.</maml:para> <maml:para>Single line of text: -Values @{"Title" = "Title New"}</maml:para> <maml:para>Multiple lines of text: -Values @{"MultiText" = "New text\n\nMore text"}</maml:para> <maml:para>Rich text: -Values @{"MultiText" = "&lt;strong&gt;New&lt;/strong&gt; text"}</maml:para> <maml:para>Choice: -Values @{"Choice" = "Value 1"}</maml:para> <maml:para>Number: -Values @{"Number" = "10"}</maml:para> <maml:para>Currency: -Values @{"Number" = "10"}</maml:para> <maml:para>Currency: -Values @{"Currency" = "10"}</maml:para> <maml:para>Date and Time: -Values @{"DateAndTime" = "04/20/2023 14:16"} (use mm/dd/yyyy)</maml:para> <maml:para>Lookup (id of lookup value): -Values @{"Lookup" = "2"}</maml:para> <maml:para>Multi value lookup (id of lookup values as array 1): -Values @{"MultiLookupField" = "1","2"}</maml:para> <maml:para>Multi value lookup (id of lookup values as array 2): -Values @{"MultiLookupField" = 1,2}</maml:para> <maml:para>Multi value lookup (id of lookup values as string): -Values @{"MultiLookupField" = "1,2"}</maml:para> <maml:para>Yes/No: -Values @{"YesNo" = $false}</maml:para> <maml:para>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"}</maml:para> <maml:para>Managed Metadata (single value with path to term): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"}</maml:para> <maml:para>Managed Metadata (single value with id of term): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term</maml:para> <maml:para>Managed Metadata (multiple values with paths to terms): -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"}</maml:para> <maml:para>Managed Metadata (multiple values with ids of terms): -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"}</maml:para> <maml:para>Hyperlink or Picture: -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnP"}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Hashtable</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFile -Path c:\temp\company.master -Folder "_catalogs/masterpage" ```</maml:para> <maml:para>This will upload the file company.master to the masterpage catalog</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFile -Path .\displaytemplate.html -Folder "_catalogs/masterpage/display templates/test" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFile -Path .\sample.doc -Folder "Shared Documents" -Values @{Modified="12/28/2023"} ```</maml:para> <maml:para>This will upload the file sample.doc to the Shared Documents folder. After uploading it will set the Modified date to 12/28/2023.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFile -FileName sample.doc -Folder "Shared Documents" -Stream $fileStream -Values @{Modified="12/28/2023"} ```</maml:para> <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 12/28/2023.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFile -Path sample.doc -Folder "Shared Documents" -ContentType "Document" -Values @{Modified="12/28/2023"} ```</maml:para> <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 12/28/2023.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFile -Path sample.docx -Folder "Documents" -Values @{Modified="12/28/2016"; Created="12/28/2023"; Editor=23} ```</maml:para> <maml:para>This will add a file sample.docx to the Documents folder and will set the Modified date to 12/28/2016, Created date to 12/28/2023 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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFile -Path sample.docx -Folder "Documents" -NewFileName "differentname.docx" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFile -FileName sample.txt -Folder "Shared Documents" -Content '{ "Test": "Value" }' ```</maml:para> <maml:para>This will create a file sample.docx in the Documents library inserting the provided plain text into it. If a similarly file already exists at this location, its contents will be overwritten.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPFileAnonymousSharingLink</command:name> <maml:description> <maml:para>Creates an anonymous sharing link to share a file.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPFileAnonymousSharingLink</command:noun> </command:details> <maml:description> <maml:para>Creates an anonymous sharing link to share a file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFileAnonymousSharingLink</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpirationDateTime</maml:name> <maml:description> <maml:para>The expiration date to be after which the file link will expire.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FileUrl</maml:name> <maml:description> <maml:para>The file in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password to be set for the file to be shared.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShareType</maml:name> <maml:description> <maml:para>The type of sharing that you want to, i.e do you want to enable people in your organization to view the shared content or also edit the content?</maml:para> <maml:para>`CreateOnly` value is not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.ShareType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpirationDateTime</maml:name> <maml:description> <maml:para>The expiration date to be after which the file link will expire.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FileUrl</maml:name> <maml:description> <maml:para>The file in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password to be set for the file to be shared.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShareType</maml:name> <maml:description> <maml:para>The type of sharing that you want to, i.e do you want to enable people in your organization to view the shared content or also edit the content?</maml:para> <maml:para>`CreateOnly` value is not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.ShareType</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileAnonymousSharingLink -FileUrl "/sites/demo/Shared Documents/Test.docx" ```</maml:para> <maml:para>This will create an anonymous sharing link for `Test.docx` file in the `Shared Documents` library which will be viewable.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileAnonymousSharingLink -FileUrl "/sites/demo/Shared Documents/Test.docx" -Type Edit -Password "PnPRocks!" ```</maml:para> <maml:para>This will create an anonymous sharing link for `Test.docx` file in the `Shared Documents` library which will be editable by anonymous users after specifying the password.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileAnonymousSharingLink -FileUrl "/sites/demo/Shared Documents/Test.docx" -Type View -ExpirationDateTime (Get-Date).AddDays(15) ```</maml:para> <maml:para>This will create an anonymous sharing link for `Test.docx` file in the `Shared Documents` library which will be viewable by anonymous users. The link will expire after 15 days.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPFileOrganizationalSharingLink</command:name> <maml:description> <maml:para>Creates an organizational sharing link for a file.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPFileOrganizationalSharingLink</command:noun> </command:details> <maml:description> <maml:para>Creates a new organization sharing link for a file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFileOrganizationalSharingLink</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FileUrl</maml:name> <maml:description> <maml:para>The file in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShareType</maml:name> <maml:description> <maml:para>The type of sharing that you want to, i.e do you want to enable people in your organization to view the shared content or also edit the content?</maml:para> <maml:para>`CreateOnly` value is not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.ShareType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FileUrl</maml:name> <maml:description> <maml:para>The file in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShareType</maml:name> <maml:description> <maml:para>The type of sharing that you want to, i.e do you want to enable people in your organization to view the shared content or also edit the content?</maml:para> <maml:para>`CreateOnly` value is not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.ShareType</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileOrganizationalSharingLink -FileUrl "/sites/demo/Shared Documents/Test.docx" ```</maml:para> <maml:para>This will create an organization sharing link for `Test.docx` file in the `Shared Documents` library which will be viewable by users in the organization.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileOrganizationalSharingLink -FileUrl "/sites/demo/Shared Documents/Test.docx" -Type Edit ```</maml:para> <maml:para>This will create an organization sharing link for `Test.docx` file in the `Shared Documents` library which will be editable by users in the organization.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPFileSensitivityLabel</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Files.ReadWrite.All, Sites.ReadWrite.All Add the sensitivity label information for a file in SharePoint.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPFileSensitivityLabel</command:noun> </command:details> <maml:description> <maml:para>The Add-PnPFileSensitivityLabel cmdlet adds the sensitivity label information for a file in SharePoint using Microsoft Graph. It takes a URL as input, decodes it, and specifically encodes the '+' character if it is part of the filename. It also takes the sensitivity label Id , assignment method and justification text values as input.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFileSensitivityLabel</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssignmentMethod</maml:name> <maml:description> <maml:para>The assignment method of the label on the document. Indicates whether the assignment of the label was done automatically, standard, or as a privileged operation (the equivalent of an administrator operation).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The server relative path to the file, the unique identifier of the file, the listitem representing the file, or the file object itself on which we are adding the sensitivity label.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FilePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>JustificationText</maml:name> <maml:description> <maml:para>Justification text for audit purposes, and is required when downgrading/removing a label.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SensitivityLabelId</maml:name> <maml:description> <maml:para>ID of the sensitivity label to be assigned, or empty string to remove the sensitivity label.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssignmentMethod</maml:name> <maml:description> <maml:para>The assignment method of the label on the document. Indicates whether the assignment of the label was done automatically, standard, or as a privileged operation (the equivalent of an administrator operation).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The server relative path to the file, the unique identifier of the file, the listitem representing the file, or the file object itself on which we are adding the sensitivity label.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FilePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>JustificationText</maml:name> <maml:description> <maml:para>Justification text for audit purposes, and is required when downgrading/removing a label.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SensitivityLabelId</maml:name> <maml:description> <maml:para>ID of the sensitivity label to be assigned, or empty string to remove the sensitivity label.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>This example adds the sensitivity label information for the file at the specified URL.</maml:para> <maml:para>```powershell Add-PnPFileSensitivityLabel -Identity "/sites/Marketing/Shared Documents/Report.pptx" -SensitivityLabelId "b5b11b04-05b3-4fe4-baa9-b7f5f65b8b64" -JustificationText "Previous label no longer applies" -AssignmentMethod Privileged ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>This example removes the sensitivity label information for the file at the specified URL.</maml:para> <maml:para>```powershell Add-PnPFileSensitivityLabel -Identity "/sites/Marketing/Shared Documents/Report.pptx" -SensitivityLabelId "" -JustificationText "Previous label no longer applies" -AssignmentMethod Privileged ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/driveitem-assignsensitivitylabel</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPFileSharingInvite</command:name> <maml:description> <maml:para>Creates an invitation for users to a file.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPFileSharingInvite</command:noun> </command:details> <maml:description> <maml:para>Creates an invitation for users to a file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFileSharingInvite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpirationDateTime</maml:name> <maml:description> <maml:para>The expiration date for the FileUrl after which the permission expires.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FileUrl</maml:name> <maml:description> <maml:para>The FileUrl in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>A plain text formatted message that is included in the sharing invitation. Maximum length 2000 characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RequireSignIn</maml:name> <maml:description> <maml:para>Specifies where the recipient of the invitation is required to sign-in to view the shared item</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParamter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specify the role that is to be granted to the recipients of the sharing invitation.</maml:para> <maml:para>Supported values are `Owner`, `Write` and `Read`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.PermissionRole</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SendInvitation</maml:name> <maml:description> <maml:para>Specifies if an email or post is generated (false) or if the permission is just created (true).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParamter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>A collection of recipients who will receive access and the sharing invitation. **Currently, only one user at a time is supported**. We are planning to add support for multiple users a bit later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpirationDateTime</maml:name> <maml:description> <maml:para>The expiration date for the FileUrl after which the permission expires.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FileUrl</maml:name> <maml:description> <maml:para>The FileUrl in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>A plain text formatted message that is included in the sharing invitation. Maximum length 2000 characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RequireSignIn</maml:name> <maml:description> <maml:para>Specifies where the recipient of the invitation is required to sign-in to view the shared item</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParamter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specify the role that is to be granted to the recipients of the sharing invitation.</maml:para> <maml:para>Supported values are `Owner`, `Write` and `Read`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.PermissionRole</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SendInvitation</maml:name> <maml:description> <maml:para>Specifies if an email or post is generated (false) or if the permission is just created (true).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParamter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>A collection of recipients who will receive access and the sharing invitation. **Currently, only one user at a time is supported**. We are planning to add support for multiple users a bit later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileSharingInvite -FileUrl "/sites/demo/Shared Documents/Test.docx" -Users "john@contoso.onmicrosoft.com" -RequireSignIn ```</maml:para> <maml:para>This will invite the user `John@contoso.onmicrosoft.com` to the `Test.docx` file with Read permissions and will require that user to sign in before accessing the file.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileSharingInvite -FileUrl "/sites/demo/Shared Documents/Test.docx" -Users "john@contoso.onmicrosoft.com" -RequireSignIn -SendInvitation -Role Owner ```</maml:para> <maml:para>This will invite the user `John@contoso.onmicrosoft.com` to the `Test.docx` file with Read permissions and will require that user to sign in before accessing the file. The invitation will be sent and the user will have `Owner` permissions</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileSharingInvite -FileUrl "/sites/demo/Shared Documents/Test.docx" -Users "john@contoso.onmicrosoft.com" -RequireSignIn -ExpirationDate (Get-Date).AddDays(15) ```</maml:para> <maml:para>This will invite the user `John@contoso.onmicrosoft.com` to the `Test.docx` file with Read permissions and will require that user to sign in before accessing the file. The link will expire after 15 days.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPFileToSiteTemplate</command:name> <maml:description> <maml:para>Adds a file to a PnP Provisioning Template package</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPFileToSiteTemplate</command:noun> </command:details> <maml:description> <maml:para>Allows adding a file to a PnP Provisioning Template package (.pnp) so that the file will get uploaded to the SharePoint Online site to which the template is being invoked. This allows the file to be referenced in i.e. a document template, site logo or any other component that references a file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFileToSiteTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <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" variableLength="true">FileLevel</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>The file to add to the PnP Provisioning Template, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <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" variableLength="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPFileToSiteTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <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" variableLength="true">FileLevel</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>SourceUrl</maml:name> <maml:description> <maml:para>The file to add to the PnP Provisioning Template, specifying its url in the current connected Web.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <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" variableLength="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <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" variableLength="true">FileLevel</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>The file to add to the PnP Provisioning Template, optionally including full path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>SourceUrl</maml:name> <maml:description> <maml:para>The file to add to the PnP Provisioning Template, specifying its url in the current connected Web.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <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" variableLength="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileToSiteTemplate -Path template.pnp -Source "Instructions.docx" -Folder "Shared Documents" ```</maml:para> <maml:para>Embeds a file named "Instructions.docx" located in the current folder on the local machine into the PnP Site Template file "template.pnp" located in the current folder on the local machine, instructing it to be uploaded to the default document library when the template is applied to a site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileToSiteTemplate -Path c:\temp\template.pnp -Source "c:\temp\Sample.pptx" -Folder "Shared Documents\Samples" ```</maml:para> <maml:para>Embeds a file named "Sample.pptx" located in the c:\temp on the local machine into the PnP Site Template file located at "c:\temp\template.pnp" on the local machine, instructing it to be uploaded to the folder Samples located in the default document library when the template is applied to a site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileToSiteTemplate -Path template.pnp -Source "./myfile.png" -Folder "folderinsite" -FileLevel Published -FileOverwrite:$false ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileToSiteTemplate -Path template.pnp -Source $sourceFilePath -Folder $targetFolder -Container $container ```</maml:para> <maml:para>Adds a file to a PnP Site Template with a custom container for the file</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileToSiteTemplate -Path template.pnp -SourceUrl "Shared%20Documents/ProjectStatus.docx" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPFileUserSharingLink</command:name> <maml:description> <maml:para>Creates a sharing link to share a file with a list of specified users.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPFileUserSharingLink</command:noun> </command:details> <maml:description> <maml:para>Creates a new user sharing link for a file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFileUserSharingLink</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FileUrl</maml:name> <maml:description> <maml:para>The file in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShareType</maml:name> <maml:description> <maml:para>The type of sharing that you want to, i.e do you want to enable people in your organization to view the shared content or also edit the content?</maml:para> <maml:para>`CreateOnly` value is not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.ShareType</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>The UPN(s) of the user(s) to with whom you would like to share the file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FileUrl</maml:name> <maml:description> <maml:para>The file in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShareType</maml:name> <maml:description> <maml:para>The type of sharing that you want to, i.e do you want to enable people in your organization to view the shared content or also edit the content?</maml:para> <maml:para>`CreateOnly` value is not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.ShareType</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>The UPN(s) of the user(s) to with whom you would like to share the file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileUserSharingLink -FileUrl "/sites/demo/Shared Documents/Test.docx" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" ```</maml:para> <maml:para>This will create an user sharing link for `Test.docx` file in the `Shared Documents` library which will be viewable to specified users in the organization.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFileUserSharingLink -FileUrl "/sites/demo/Shared Documents/Test.docx" -Type Edit -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" ```</maml:para> <maml:para>This will create an user sharing link for `Test.docx` file in the `Shared Documents` library which will be editable by specified users in the organization.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPFlowOwner</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: management.azure.com Assigns/updates permissions to a Power Automate flow</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPFlowOwner</command:noun> </command:details> <maml:description> <maml:para>This cmdlet assigns/updates permissions for a user to a Power Automate flow.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFlowOwner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>If specified, the permission will be set as an admin. If not specified only the flows to which the current user already has access can be modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Name, Id or instance of the Power Automate Flow to add the permissions to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerPlatformPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>The type of permissions to assign to the user on the Power Automate Flow. Valid values: CanView, CanViewWithShare, CanEdit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FlowUseFlowAccessRolerRoleName</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user principal name or Id of the user to assign permissions to the Power Automate Flow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>If specified, the permission will be set as an admin. If not specified only the flows to which the current user already has access can be modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Name, Id or instance of the Power Automate Flow to add the permissions to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerPlatformPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>The type of permissions to assign to the user on the Power Automate Flow. Valid values: CanView, CanViewWithShare, CanEdit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FlowUseFlowAccessRolerRoleName</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user principal name or Id of the user to assign permissions to the Power Automate Flow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFlowOwner -Identity f07c34a9-a586-4e58-91fb-e7ea19741b61 -User username@tenant.onmicrosoft.com -Role CanEdit ``` Assigns the specified user with 'CanEdit' access level to the specified flow in the default environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFlowOwner -Identity f07c34a9-a586-4e58-91fb-e7ea19741b61 -User 6844c04a-8ee7-40ad-af66-28f6e948cd04 -Role CanView ``` Assigns the specified user with 'CanView' access level to the specified flow in the default environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFlowOwner -Environment (Get-PnPPowerPlatformEnvironment -Identity "myenvironment") -Identity f07c34a9-a586-4e58-91fb-e7ea19741b61 -User 6844c04a-8ee7-40ad-af66-28f6e948cd04 -Role CanViewWithShare ``` Assigns the specified user with 'CanViewWithShare' access level to the specified flow in the specified environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFlowOwner -Environment (Get-PnPPowerPlatformEnvironment -Identity "myenvironment") -Identity f07c34a9-a586-4e58-91fb-e7ea19741b61 -User username@tenant.onmicrosoft.com -AsAdmin -Role CanEdit ``` Assigns the specified user with 'CanEdit' access level to the specified flow as admin in the specified environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPFolder</command:name> <maml:description> <maml:para>Creates a folder within a parent folder</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPFolder</command:noun> </command:details> <maml:description> <maml:para>Allows to add a new folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The parent folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The folder name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The parent folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The folder name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFolder -Name NewFolder -Folder _catalogs/masterpage ```</maml:para> <maml:para>This will create the folder NewFolder in the masterpage catalog</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFolder -Name NewFolder -Folder "Shared Documents" ```</maml:para> <maml:para>This will create the folder NewFolder in the Documents library</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFolder -Name NewFolder -Folder "Shared Documents/Folder" ```</maml:para> <maml:para>This will create the folder NewFolder in Folder inside the Documents library</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPFolderAnonymousSharingLink</command:name> <maml:description> <maml:para>Creates an anonymous sharing link to share a folder.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPFolderAnonymousSharingLink</command:noun> </command:details> <maml:description> <maml:para>Creates a new anonymous sharing link for a folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFolderAnonymousSharingLink</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpirationDateTime</maml:name> <maml:description> <maml:para>The expiration date for the folder after which the shared link will stop working.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the folder which will be shared anonymously.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShareType</maml:name> <maml:description> <maml:para>The type of sharing that you want to, i.e do you want to enable anonymous users to view the shared content or also edit the content?</maml:para> <maml:para>`Review` and `BlocksDownload` values are not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.ShareType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpirationDateTime</maml:name> <maml:description> <maml:para>The expiration date for the folder after which the shared link will stop working.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the folder which will be shared anonymously.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShareType</maml:name> <maml:description> <maml:para>The type of sharing that you want to, i.e do you want to enable anonymous users to view the shared content or also edit the content?</maml:para> <maml:para>`Review` and `BlocksDownload` values are not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.ShareType</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFolderAnonymousSharingLink -Folder "/sites/demo/Shared Documents/Test" ```</maml:para> <maml:para>This will create an anonymous sharing link for `Test` folder in the `Shared Documents` library which will be viewable to anonymous users.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFolderAnonymousSharingLink -Folder "/sites/demo/Shared Documents/Test" -Type Edit -Password "PnPRocks!" ```</maml:para> <maml:para>This will create an anonymous sharing link for `Test` folder in the `Shared Documents` library which will be editable by anonymous users with the specified password.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFolderAnonymousSharingLink -Folder "/sites/demo/Shared Documents/Test" -Type Edit -Password "PnPRocks!" -ExpirationDateTime (Get-Date).AddDays(15) ```</maml:para> <maml:para>This will create an anonymous sharing link for `Test` folder in the `Shared Documents` library which will be editable by anonymous users with the specified password. The link will expire after 15 days.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPFolderOrganizationalSharingLink</command:name> <maml:description> <maml:para>Creates an organizational sharing link for a folder.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPFolderOrganizationalSharingLink</command:noun> </command:details> <maml:description> <maml:para>Creates a new organization sharing link for a folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFolderOrganizationalSharingLink</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShareType</maml:name> <maml:description> <maml:para>The type of sharing that you want to, i.e do you want to enable people in your organization to view the shared content or also edit the content?</maml:para> <maml:para>`Review` and `BlocksDownload` values are not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.ShareType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShareType</maml:name> <maml:description> <maml:para>The type of sharing that you want to, i.e do you want to enable people in your organization to view the shared content or also edit the content?</maml:para> <maml:para>`Review` and `BlocksDownload` values are not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.ShareType</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFolderOrganizationalSharingLink -Folder "/sites/demo/Shared Documents/Test" ```</maml:para> <maml:para>This will create an organization sharing link for `Test` folder in the `Shared Documents` library which will be viewable by users in the organization.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFolderOrganizationalSharingLink -Folder "/sites/demo/Shared Documents/Test" -Type Edit ```</maml:para> <maml:para>This will create an organization sharing link for `Test` folder in the `Shared Documents` library which will be editable by users in the organization.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPFolderSharingInvite</command:name> <maml:description> <maml:para>Creates an invitation for users to a folder.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPFolderSharingInvite</command:noun> </command:details> <maml:description> <maml:para>Creates an invitation for user to a folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFolderSharingInvite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpirationDateTime</maml:name> <maml:description> <maml:para>The expiration date for the folder after which the permission expires.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>A plain text formatted message that is included in the sharing invitation. Maximum length 2000 characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RequireSignIn</maml:name> <maml:description> <maml:para>Specifies where the recipient of the invitation is required to sign-in to view the shared item</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParamter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specify the role that is to be granted to the recipients of the sharing invitation.</maml:para> <maml:para>Supported values are `Owner`, `Write` and `Read`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.PermissionRole</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SendInvitation</maml:name> <maml:description> <maml:para>Specifies if an email or post is generated (false) or if the permission is just created (true).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParamter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>A collection of recipients who will receive access and the sharing invitation. **Currently, only one user at a time is supported**. We are planning to add support for multiple users a bit later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpirationDateTime</maml:name> <maml:description> <maml:para>The expiration date for the folder after which the permission expires.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>A plain text formatted message that is included in the sharing invitation. Maximum length 2000 characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RequireSignIn</maml:name> <maml:description> <maml:para>Specifies where the recipient of the invitation is required to sign-in to view the shared item</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParamter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specify the role that is to be granted to the recipients of the sharing invitation.</maml:para> <maml:para>Supported values are `Owner`, `Write` and `Read`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.PermissionRole</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SendInvitation</maml:name> <maml:description> <maml:para>Specifies if an email or post is generated (false) or if the permission is just created (true).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParamter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>A collection of recipients who will receive access and the sharing invitation. **Currently, only one user at a time is supported**. We are planning to add support for multiple users a bit later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFolderSharingInvite -Folder "/sites/demo/Shared Documents/Test" -Users "john@contoso.onmicrosoft.com" -RequireSignIn ```</maml:para> <maml:para>This will invite the user `John@contoso.onmicrosoft.com` to the `Test` folder with Read permissions and will require that user to sign in before accessing the folder.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFolderSharingInvite -Folder "/sites/demo/Shared Documents/Test" -Users "john@contoso.onmicrosoft.com" -RequireSignIn -SendInvitation -Role Owner ```</maml:para> <maml:para>This will invite the user `John@contoso.onmicrosoft.com` to the `Test` folder with Read permissions and will require that user to sign in before accessing the folder. The invitation will be sent and the user will have `Owner` permissions</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFolderSharingInvite -Folder "/sites/demo/Shared Documents/Test" -Users "john@contoso.onmicrosoft.com" -RequireSignIn -ExpirationDate (Get-Date).AddDays(15) ```</maml:para> <maml:para>This will invite the user `John@contoso.onmicrosoft.com` to the `Test` folder with Read permissions and will require that user to sign in before accessing the folder. The link will expire after 15 days.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPFolderUserSharingLink</command:name> <maml:description> <maml:para>Creates a sharing link to share a folder with a list of specified users.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPFolderUserSharingLink</command:noun> </command:details> <maml:description> <maml:para>Creates a new user sharing link for a folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPFolderUserSharingLink</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShareType</maml:name> <maml:description> <maml:para>The type of sharing that you want to, i.e do you want to enable people in your organization to view the shared content or also edit the content?</maml:para> <maml:para>`Review` and `BlocksDownload` values are not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.ShareType</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>The UPN(s) of the user(s) to with whom you would like to share the folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShareType</maml:name> <maml:description> <maml:para>The type of sharing that you want to, i.e do you want to enable people in your organization to view the shared content or also edit the content?</maml:para> <maml:para>`Review` and `BlocksDownload` values are not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.Core.Model.Security.ShareType</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>The UPN(s) of the user(s) to with whom you would like to share the folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFolderUserSharingLink -Folder "/sites/demo/Shared Documents/Test" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" ```</maml:para> <maml:para>This will create an user sharing link for `Test` folder in the `Shared Documents` library which will be viewable to specified users in the organization.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPFolderUserSharingLink -Folder "/sites/demo/Shared Documents/Test" -ShareType Edit -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" ```</maml:para> <maml:para>This will create an user sharing link for `Test` folder in the `Shared Documents` library which will be editable by specified users in the organization.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPGroupMember</command:name> <maml:description> <maml:para>Adds a user to a SharePoint group</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPGroupMember</command:noun> </command:details> <maml:description> <maml:para>Allows to add new user to SharePoint group. The SharePoint group may be specified either by id, name or related object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPGroupMember</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>The SharePoint group id, SharePoint group name or SharePoint group object to add the user to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>The login name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPGroupMember</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>The email address of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EmailBody</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>The SharePoint group id, SharePoint group name or SharePoint group object to add the user to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SendEmail</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPGroupMember</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Batch</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">PnPBatch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>The SharePoint group id, SharePoint group name or SharePoint group object to add the user to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">GroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Batch</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">PnPBatch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>The email address of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EmailBody</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>The SharePoint group id, SharePoint group name or SharePoint group object to add the user to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>The login name of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SendEmail</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPGroupMember -LoginName user@company.com -Group 'Marketing Site Members' ```</maml:para> <maml:para>Add the specified user to the SharePoint group "Marketing Site Members"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPGroupMember -LoginName user@company.com -Group 5 ```</maml:para> <maml:para>Add the specified user to the SharePoint group with Id 5</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell $batch = New-PnPBatch Add-PnPGroupMember -LoginName user@company.com -Group 5 -Batch $batch Add-PnPGroupMember -LoginName user1@company.com -Group 5 -Batch $batch Invoke-PnPBatch $batch ```</maml:para> <maml:para>Add the specified users to the SharePoint group with Id 5 in a batch.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPHomeSite</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Adds the home site to your tenant. The home site needs to be a communication site.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPHomeSite</command:noun> </command:details> <maml:description> <maml:para>Adds a home site to the current tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPHomeSite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>HomeSiteUrl</maml:name> <maml:description> <maml:para>The url of the site to set as the home site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>HomeSiteUrl</maml:name> <maml:description> <maml:para>The url of the site to set as the home site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPHomeSite -HomeSiteUrl "https://yourtenant.sharepoint.com/sites/myhome" ```</maml:para> <maml:para>Adds a home site with the provided site collection url</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set up a home site for your organization</maml:linkText> <command:uri>https://learn.microsoft.com/sharepoint/home-site</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Customize and edit the Viva Connections home experience</maml:linkText> <command:uri>https://learn.microsoft.com/en-us/viva/connections/edit-viva-home</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPHtmlPublishingPageLayout</command:name> <maml:description> <maml:para>Adds a HTML based publishing page layout</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPHtmlPublishingPageLayout</command:noun> </command:details> <maml:description> <maml:para>Allows to add a HTML based publishing page layout.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPHtmlPublishingPageLayout</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssociatedContentTypeID</maml:name> <maml:description> <maml:para>Associated content type ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssociatedContentTypeID</maml:name> <maml:description> <maml:para>Associated content type ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPHtmlPublishingPageLayout -Title 'Our custom page layout' -SourceFilePath 'customlayout.aspx' -Description 'A custom page layout' -AssociatedContentTypeID 0x01010901 ```</maml:para> <maml:para>Uploads the pagelayout 'customlayout.aspx' from the current location to the current site as a 'web part page' pagelayout</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPHubSiteAssociation</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Connects a site to a hubsite.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPHubSiteAssociation</command:noun> </command:details> <maml:description> <maml:para>Connects an existing site to a hubsite</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPHubSiteAssociation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>HubSite</maml:name> <maml:description> <maml:para>The hubsite to connect the site to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to connect to the hubsite</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>HubSite</maml:name> <maml:description> <maml:para>The hubsite to connect the site to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to connect to the hubsite</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPHubSiteAssociation -Site "https://tenant.sharepoint.com/sites/mysite" -HubSite "https://tenant.sharepoint.com/sites/hubsite" ```</maml:para> <maml:para>This example adds the specified site to the hubsite.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPHubToHubAssociation</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Associates a hub site to another hub site to build a hierarchy of hubs. The association only is a content association, meaning that only the content of the underlying associates sites will surface in webparts such as the news webpart. No other settings will be inherited. At most 3 levels of hubs can be associated with each other.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPHubToHubAssociation</command:noun> </command:details> <maml:description> <maml:para>Use this cmdlet to associate a hub site to a hub site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPHubToHubAssociation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>HubSiteId of the Source Hub site to be associated with the Target Hub Site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>HubSiteId of the Target Hub to associate the source Hub to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPHubToHubAssociation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SourceUrl</maml:name> <maml:description> <maml:para>URL of the Source Hub site to be associated with the Target Hub Site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TargetUrl</maml:name> <maml:description> <maml:para>URL of the Target Hub to associate the source Hub to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Source</maml:name> <maml:description> <maml:para>HubSiteId of the Source Hub site to be associated with the Target Hub Site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SourceUrl</maml:name> <maml:description> <maml:para>URL of the Source Hub site to be associated with the Target Hub Site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>HubSiteId of the Target Hub to associate the source Hub to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TargetUrl</maml:name> <maml:description> <maml:para>URL of the Target Hub to associate the source Hub to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPHubToHubAssociation -Source 6638bd4c-d88d-447c-9eb2-c84f28ba8b15 -Target 0b70f9de-2b98-46e9-862f-ba5700aa2443 ```</maml:para> <maml:para>This example associates the source hub site with the HubSiteId 6638bd4c-d88d-447c-9eb2-c84f28ba8b15 with the target hub site with the HubSiteId 0b70f9de-2b98-46e9-862f-ba5700aa2443.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPHubToHubAssociation -SourceUrl "https://yourtenant.sharepoint.com/sites/sourcehub" -TargetUrl "https://yourtenant.sharepoint.com/sites/targethub" ```</maml:para> <maml:para>This example associates the source hub site with the url https://yourtenant.sharepoint.com/sites/sourcehub with the target hub site with the url https://yourtenant.sharepoint.com/sites/targethub.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPHubToHubAssociation -SourceUrl "https://yourtenant.sharepoint.com/sites/secondlevelhub" -TargetUrl "https://yourtenant.sharepoint.com/sites/toplevelhub" Add-PnPHubToHubAssociation -SourceUrl "https://yourtenant.sharepoint.com/sites/thirdlevelhub" -TargetUrl "https://yourtenant.sharepoint.com/sites/secondlevelhub" ```</maml:para> <maml:para>This example associates the source hub site with the url https://yourtenant.sharepoint.com/sites/secondlevelhub with the target hub site with the url https://yourtenant.sharepoint.com/sites/toplevelhub and then associates the source hub site with the url https://yourtenant.sharepoint.com/sites/thirdlevelhub with the target hub site with the url https://yourtenant.sharepoint.com/sites/secondlevelhub to generate a three-level hub site structure. Note that 3 levels of hub site connections is the maximum supported amount. Content on sites beyond level 3 will not appear in search results.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Add</command:verb> <command:noun>PnPIndexedProperty</command:noun> </command:details> <maml:description> <maml:para>Allows to set search index on propertybag key.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPIndexedProperty</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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, valid only for SharePoint classic site experience.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPJavaScriptBlock</command:noun> </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="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPJavaScriptBlock -Name myAction -script '<script>Alert("This is my Script block");</script>' -Sequence 9999 -Scope Site ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPJavaScriptBlock -Name myAction -script '<script>Alert("This is my Script block");</script>' ```</maml:para> <maml:para>Add a JavaScript code block to all pages within the current web under the name myAction</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPJavaScriptLink</command:name> <maml:description> <maml:para>Adds a link to a JavaScript file to a web or sitecollection, valid only for SharePoint classic site experience.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPJavaScriptLink</command:noun> </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="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name under which to register the JavaScriptLink</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>URL to the JavaScript file to inject</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name under which to register the JavaScriptLink</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>URL to the JavaScript file to inject</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPJavaScriptLink -Name jQuery -Url https://code.jquery.com/jquery.min.js -Sequence 9999 -Scope Site ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPJavaScriptLink -Name jQuery -Url https://code.jquery.com/jquery.min.js ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPListDesign</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Creates a new List Design on the current tenant</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPListDesign</command:noun> </command:details> <maml:description> <maml:para>Allows to add new List Design to tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPListDesign</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the list design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ListColor</maml:name> <maml:description> <maml:para>The list color from the create list experience.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantListDesignColor</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ListIcon</maml:name> <maml:description> <maml:para>The list icon from the create list experience.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantListDesignIcon</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteScript</maml:name> <maml:description> <maml:para>An instance, id or title of a site script to use for the list design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TenantSiteScriptPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>The full URL of a thumbnail image, i.e. https://contoso.sharepoint/siteassets/image.png. If none is specified, SharePoint uses a generic image. This is the image that will be shown in the "From your organization" section of the "Create" List screen.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the list design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPListDesign</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the list design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ListColor</maml:name> <maml:description> <maml:para>The list color from the create list experience.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantListDesignColor</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ListIcon</maml:name> <maml:description> <maml:para>The list icon from the create list experience.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantListDesignIcon</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteScriptIds</maml:name> <maml:description> <maml:para>An array of guids of site scripts to use for the list design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>The full URL of a thumbnail image, i.e. https://contoso.sharepoint/siteassets/image.png. If none is specified, SharePoint uses a generic image. This is the image that will be shown in the "From your organization" section of the "Create" List screen.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the list design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the list design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ListColor</maml:name> <maml:description> <maml:para>The list color from the create list experience.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantListDesignColor</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ListIcon</maml:name> <maml:description> <maml:para>The list icon from the create list experience.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantListDesignIcon</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteScript</maml:name> <maml:description> <maml:para>An instance, id or title of a site script to use for the list design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TenantSiteScriptPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteScriptIds</maml:name> <maml:description> <maml:para>An array of guids of site scripts to use for the list design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>The full URL of a thumbnail image, i.e. https://contoso.sharepoint/siteassets/image.png. If none is specified, SharePoint uses a generic image. This is the image that will be shown in the "From your organization" section of the "Create" List screen.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the list design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListDesign -Title "My Custom List" -SiteScriptIds "e84dcb46-3ab9-4456-a136-66fc6ae3d3c5" ```</maml:para> <maml:para>Adds a new List Design, with the specified title and description. When applied it will run the scripts as referenced by the IDs. Use Get-PnPSiteScript to receive site Scripts.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListDesign -Title "My Company Design" -SiteScriptIds "6def687f-0e08-4f1e-999c-791f3af9a600" -Description "My description" -ListColor Orange -ListIcon BullseyeTarget -ThumbnailUrl "https://contoso.sharepoint.com/SiteAssets/site-thumbnail.png" ```</maml:para> <maml:para>Adds a new List Design, with the specified title, description and list color, list icon and thumbnail to be shown in the template picker. When applied it will run the scripts as referenced by the IDs. Use Get-PnPSiteScript to receive Site Scripts.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteScript -Identity "My List Script" | Add-PnPListDesign -Title "My Custom List" ```</maml:para> <maml:para>Adds a new List Design, with the specified title based on a site script with the title "My List Script"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPList -Identity "My List" | Get-PnPSiteScriptFromList | Add-PnPSiteScript -Title "My List Script" | Add-PnPListDesign -Title "My List" ```</maml:para> <maml:para>Adds a new List Design and site script based on a list with the title "My List"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPListFoldersToSiteTemplate</command:name> <maml:description> <maml:para>Adds folders to a list in a PnP Provisioning Template</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPListFoldersToSiteTemplate</command:noun> </command:details> <maml:description> <maml:para>Allows to add folders to a list in a PnP Provisioning Template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPListFoldersToSiteTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="none"> <maml:name>IncludeSecurity</maml:name> <maml:description> <maml:para>A switch to include ObjectSecurity information.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6" aliases="none"> <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" variableLength="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="none"> <maml:name>IncludeSecurity</maml:name> <maml:description> <maml:para>A switch to include ObjectSecurity information.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6" aliases="none"> <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" variableLength="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListFoldersToSiteTemplate -Path template.pnp -List 'PnPTestList' ```</maml:para> <maml:para>Adds top level folders from a list to an existing template and returns an in-memory PnP Site Template</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListFoldersToSiteTemplate -Path template.pnp -List 'PnPTestList' -Recursive ```</maml:para> <maml:para>Adds all folders from a list to an existing template and returns an in-memory PnP Site Template</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListFoldersToSiteTemplate -Path template.pnp -List 'PnPTestList' -Recursive -IncludeSecurity ```</maml:para> <maml:para>Adds all folders from a list with unique permissions to an in-memory PnP Site Template</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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. <a href="https://pnp.github.io/powershell/articles/batching.html"> <img src="https://raw.githubusercontent.com/pnp/powershell/gh-pages/images/batching/Batching.png" alt="Supports Batching"> </a></maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPListItem</command:noun> </command:details> <maml:description> <maml:para>Allows to add 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> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPListItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Label</maml:name> <maml:description> <maml:para>The name of the retention label.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names.</maml:para> <maml:para>Single line of text: ``` -Values @{"Title" = "Title New"} ```</maml:para> <maml:para>Multiple lines of text: ``` -Values @{"MultiText" = "New text\n\nMore text"} ```</maml:para> <maml:para>Rich text: ``` -Values @{"MultiText" = "&lt;strong&gt;New&lt;/strong&gt; text"} ```</maml:para> <maml:para>Choice: ``` -Values @{"Choice" = "Choice 1"} ```</maml:para> <maml:para>Multi-Choice: ``` -Values @{"MultiChoice" = "Choice 1","Choice 2"} ```</maml:para> <maml:para>Number: ``` -Values @{"Number" = "10"} ```</maml:para> <maml:para>Currency: ``` -Values @{"Currency" = "10"} ```</maml:para> <maml:para>> [!NOTE] > For numeric and currency fields, when using -Batch, provide the value using the comma and dots matching the regional setting of the site you're adding the listitem to. When not using batch, you must always provide the value in the American notation, so dot for decimals and comma for thousands separators.</maml:para> <maml:para>Date and Time: ``` -Values @{"DateAndTime" = "03/13/2015 14:16"} ```</maml:para> <maml:para>Lookup (id of lookup value): ``` -Values @{"Lookup" = "2"} ```</maml:para> <maml:para>Multi value lookup (id of lookup values as array 1): ``` -Values @{"MultiLookupField" = "1","2"} ```</maml:para> <maml:para>Multi value lookup (id of lookup values as array 2): ``` -Values @{"MultiLookupField" = 1,2} ```</maml:para> <maml:para>Multi value lookup (id of lookup values as string): ``` -Values @{"MultiLookupField" = "1,2"} ```</maml:para> <maml:para>Yes/No: ``` -Values @{"YesNo" = $false} ```</maml:para> <maml:para>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"} ```</maml:para> <maml:para>**If the user is not present, in the site user information list, you need to add that user using `New-PnPUser` cmdlet.**</maml:para> <maml:para>Managed Metadata (single value with path to term): ``` -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} ```</maml:para> <maml:para>Managed Metadata (single value with id of term): ``` -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term ```</maml:para> <maml:para>Managed Metadata (multiple values with paths to terms): ``` -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} ```</maml:para> <maml:para>Managed Metadata (multiple values with ids of terms): ``` -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} ```</maml:para> <maml:para>Hyperlink or Picture: ``` -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnP"} ```</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Hashtable</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPListItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Optional batch object used to add items in a batched manner. See examples on how to use this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PnPBatch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names.</maml:para> <maml:para>Single line of text: ``` -Values @{"Title" = "Title New"} ```</maml:para> <maml:para>Multiple lines of text: ``` -Values @{"MultiText" = "New text\n\nMore text"} ```</maml:para> <maml:para>Rich text: ``` -Values @{"MultiText" = "&lt;strong&gt;New&lt;/strong&gt; text"} ```</maml:para> <maml:para>Choice: ``` -Values @{"Choice" = "Choice 1"} ```</maml:para> <maml:para>Multi-Choice: ``` -Values @{"MultiChoice" = "Choice 1","Choice 2"} ```</maml:para> <maml:para>Number: ``` -Values @{"Number" = "10"} ```</maml:para> <maml:para>Currency: ``` -Values @{"Currency" = "10"} ```</maml:para> <maml:para>> [!NOTE] > For numeric and currency fields, when using -Batch, provide the value using the comma and dots matching the regional setting of the site you're adding the listitem to. When not using batch, you must always provide the value in the American notation, so dot for decimals and comma for thousands separators.</maml:para> <maml:para>Date and Time: ``` -Values @{"DateAndTime" = "03/13/2015 14:16"} ```</maml:para> <maml:para>Lookup (id of lookup value): ``` -Values @{"Lookup" = "2"} ```</maml:para> <maml:para>Multi value lookup (id of lookup values as array 1): ``` -Values @{"MultiLookupField" = "1","2"} ```</maml:para> <maml:para>Multi value lookup (id of lookup values as array 2): ``` -Values @{"MultiLookupField" = 1,2} ```</maml:para> <maml:para>Multi value lookup (id of lookup values as string): ``` -Values @{"MultiLookupField" = "1,2"} ```</maml:para> <maml:para>Yes/No: ``` -Values @{"YesNo" = $false} ```</maml:para> <maml:para>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"} ```</maml:para> <maml:para>**If the user is not present, in the site user information list, you need to add that user using `New-PnPUser` cmdlet.**</maml:para> <maml:para>Managed Metadata (single value with path to term): ``` -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} ```</maml:para> <maml:para>Managed Metadata (single value with id of term): ``` -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term ```</maml:para> <maml:para>Managed Metadata (multiple values with paths to terms): ``` -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} ```</maml:para> <maml:para>Managed Metadata (multiple values with ids of terms): ``` -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} ```</maml:para> <maml:para>Hyperlink or Picture: ``` -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnP"} ```</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Hashtable</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Optional batch object used to add items in a batched manner. See examples on how to use this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PnPBatch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Label</maml:name> <maml:description> <maml:para>The name of the retention label.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Values</maml:name> <maml:description> <maml:para>Use the internal names of the fields when specifying field names.</maml:para> <maml:para>Single line of text: ``` -Values @{"Title" = "Title New"} ```</maml:para> <maml:para>Multiple lines of text: ``` -Values @{"MultiText" = "New text\n\nMore text"} ```</maml:para> <maml:para>Rich text: ``` -Values @{"MultiText" = "&lt;strong&gt;New&lt;/strong&gt; text"} ```</maml:para> <maml:para>Choice: ``` -Values @{"Choice" = "Choice 1"} ```</maml:para> <maml:para>Multi-Choice: ``` -Values @{"MultiChoice" = "Choice 1","Choice 2"} ```</maml:para> <maml:para>Number: ``` -Values @{"Number" = "10"} ```</maml:para> <maml:para>Currency: ``` -Values @{"Currency" = "10"} ```</maml:para> <maml:para>> [!NOTE] > For numeric and currency fields, when using -Batch, provide the value using the comma and dots matching the regional setting of the site you're adding the listitem to. When not using batch, you must always provide the value in the American notation, so dot for decimals and comma for thousands separators.</maml:para> <maml:para>Date and Time: ``` -Values @{"DateAndTime" = "03/13/2015 14:16"} ```</maml:para> <maml:para>Lookup (id of lookup value): ``` -Values @{"Lookup" = "2"} ```</maml:para> <maml:para>Multi value lookup (id of lookup values as array 1): ``` -Values @{"MultiLookupField" = "1","2"} ```</maml:para> <maml:para>Multi value lookup (id of lookup values as array 2): ``` -Values @{"MultiLookupField" = 1,2} ```</maml:para> <maml:para>Multi value lookup (id of lookup values as string): ``` -Values @{"MultiLookupField" = "1,2"} ```</maml:para> <maml:para>Yes/No: ``` -Values @{"YesNo" = $false} ```</maml:para> <maml:para>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"} ```</maml:para> <maml:para>**If the user is not present, in the site user information list, you need to add that user using `New-PnPUser` cmdlet.**</maml:para> <maml:para>Managed Metadata (single value with path to term): ``` -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE"} ```</maml:para> <maml:para>Managed Metadata (single value with id of term): ``` -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818"} with Id of term ```</maml:para> <maml:para>Managed Metadata (multiple values with paths to terms): ``` -Values @{"MetadataField" = "CORPORATE|DEPARTMENTS|FINANCE","CORPORATE|DEPARTMENTS|HR"} ```</maml:para> <maml:para>Managed Metadata (multiple values with ids of terms): ``` -Values @{"MetadataField" = "fe40a95b-2144-4fa2-b82a-0b3d0299d818","52d88107-c2a8-4bf0-adfa-04bc2305b593"} ```</maml:para> <maml:para>Hyperlink or Picture: ``` -Values @{"Hyperlink" = "https://github.com/OfficeDev/, OfficePnP"} ```</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Hashtable</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListItem -List "Demo List" -Values @{"Title" = "Test Title"; "Category"="Test Category"} ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListItem -List "Demo List" -ContentType "Company" -Values @{"Title" = "Test Title"; "Category"="Test Category"} ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListItem -List "Demo List" -Values @{"MultiUserField"="user1@domain.com","user2@domain.com"} ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListItem -List "Demo List" -Values @{"Title"="Sales Report"} -Folder "projects/europe" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListItem -List "Demo List" -Values @{"Title"="Sales Report"} -Label "Public" ```</maml:para> <maml:para>Adds a new list item to the "Demo List". Sets the retention label to "Public" if it exists on the site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell $batch = New-PnPBatch for($i=0;$i -lt 10;$i++) { Add-PnPListItem -List "Demo List" -Values @{"Title"="Report $i"} -Batch $batch } Invoke-PnPBatch -Batch $batch ```</maml:para> <maml:para>This creates 10 list items by using a batched approach.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPListItemAttachment</command:name> <maml:description> <maml:para>Adds an attachment to the specified list item in the SharePoint list</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPListItemAttachment</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows adding a file as an attachment to a list item in a SharePoint Online list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPListItemAttachment</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object to add the attachment to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list. Note that when providing the name of the list, the name is case-sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPListItemAttachment</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object to add the attachment to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list. Note that when providing the name of the list, the name is case-sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPListItemAttachment</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object to add the attachment to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list. Note that when providing the name of the list, the name is case-sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Content</maml:name> <maml:description> <maml:para>Specify text of the attachment for the list item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Filename to give to the attachment file on SharePoint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the listitem, or actual ListItem object to add the attachment to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list. Note that when providing the name of the list, the name is case-sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>NewFileName</maml:name> <maml:description> <maml:para>Filename to give to the attachment file on SharePoint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The local file path</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Stream</maml:name> <maml:description> <maml:para>Stream with the file contents</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Stream</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListItemAttachment -List "Demo List" -Identity 1 -Path c:\temp\test.mp4 ```</maml:para> <maml:para>Adds a new attachment to the list item with Id "1" in the "Demo List" SharePoint list with file name as test.mp4 from the specified path.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListItemAttachment -List "Demo List" -Identity 1 -FileName "test.txt" -Content '{ "Test": "Value" }' ```</maml:para> <maml:para>Adds a new attachment to the list item with Id "1" in the "Demo List" SharePoint list with file name as test.txt and content as specified.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListItemAttachment -List "Demo List" -Identity 1 -FileName "test.mp4" -Stream $fileStream ```</maml:para> <maml:para>Adds a new attachment to the list item with Id "1" in the "Demo List" SharePoint list with file name as test.mp4 and content coming from a stream.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPListItemComment</command:name> <maml:description> <maml:para>Adds a comment to the specified list item in the SharePoint list</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPListItemComment</command:noun> </command:details> <maml:description> <maml:para>Allows to add comment to the specified list item.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPListItemComment</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specify text of the comment for the list item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specify text of the comment for the list item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPListItemComment -List "Demo List" -Identity "1" -Text "Hello world" ```</maml:para> <maml:para>Adds a new comment to the list item with Id "1" in the "Demo List" SharePoint list.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPMasterPage</command:name> <maml:description> <maml:para>Adds a Masterpage</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPMasterPage</command:noun> </command:details> <maml:description> <maml:para>Allows to add MasterPage.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPMasterPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the MasterPage</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the MasterPage</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UIVersion</maml:name> <maml:description> <maml:para>UIVersion of the MasterPage. Default = 15</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the MasterPage</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the MasterPage</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UIVersion</maml:name> <maml:description> <maml:para>UIVersion of the MasterPage. Default = 15</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPMasterPage -SourceFilePath "page.master" -Title "MasterPage" -Description "MasterPage for Web" -DestinationFolderHierarchy "SubFolder" ```</maml:para> <maml:para>Adds a MasterPage from the local file "page.master" to the folder "SubFolder" in the MasterPage gallery.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPMicrosoft365GroupMember</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: All of Group.ReadWrite.All, User.ReadWrite.All Adds members to a particular Microsoft 365 Group.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPMicrosoft365GroupMember</command:noun> </command:details> <maml:description> <maml:para>Allows to add multiple users to Microsoft 365 Group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPMicrosoft365GroupMember</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group to add members to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RemoveExisting</maml:name> <maml:description> <maml:para>If provided, all existing members will be removed and only those provided through Users will become members.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>The UPN(s) of the user(s) to add to the Microsoft 365 Group as a member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group to add members to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RemoveExisting</maml:name> <maml:description> <maml:para>If provided, all existing members will be removed and only those provided through Users will become members.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>The UPN(s) of the user(s) to add to the Microsoft 365 Group as a member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPMicrosoft365GroupMember -Identity "Project Team" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" ```</maml:para> <maml:para>Adds the provided two users as additional members to the Microsoft 365 Group named "Project Team".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPMicrosoft365GroupMember -Identity "Project Team" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" -RemoveExisting ```</maml:para> <maml:para>Sets the provided two users as the only members of the Microsoft 365 Group named "Project Team" by removing any current existing members first.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/group-post-members</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPMicrosoft365GroupOwner</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: All of Group.ReadWrite.All, User.ReadWrite.All Adds users to a Microsoft 365 Group as Owners.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPMicrosoft365GroupOwner</command:noun> </command:details> <maml:description> <maml:para>Allows to add multiple users to Microsoft 365 Group as owners.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPMicrosoft365GroupOwner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group to add owners to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RemoveExisting</maml:name> <maml:description> <maml:para>If provided, all existing owners will be removed and only those provided through Users parameter will become owners.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>The UPN(s) of the user(s) to add to the Microsoft 365 Group as an owner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group to add owners to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RemoveExisting</maml:name> <maml:description> <maml:para>If provided, all existing owners will be removed and only those provided through Users parameter will become owners.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>The UPN(s) of the user(s) to add to the Microsoft 365 Group as an owner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPMicrosoft365GroupOwner -Identity "Project Team" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" ```</maml:para> <maml:para>Adds the provided two users as additional owners to the Microsoft 365 Group named "Project Team".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPMicrosoft365GroupOwner -Identity "Project Team" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" -RemoveExisting ```</maml:para> <maml:para>Sets the provided two users as the only owners of the Microsoft 365 Group named "Project Team" by removing any current existing members first.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/group-post-members</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPMicrosoft365GroupToSite</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Groupifies a classic team site by creating a Microsoft 365 group for it and connecting the site with the newly created group.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPMicrosoft365GroupToSite</command:noun> </command:details> <maml:description> <maml:para>This command allows you to add a Microsoft 365 Unified group to an existing classic site collection, also known as groupifying.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPMicrosoft365GroupToSite</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Alias</maml:name> <maml:description> <maml:para>Specifies the alias of the group. Cannot contain spaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Classification</maml:name> <maml:description> <maml:para>Specifies the classification of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The optional description of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>HubSiteId</maml:name> <maml:description> <maml:para>If specified the site will be associated to the hubsite as identified by this id.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsPublic</maml:name> <maml:description> <maml:para>Specifies if the group is public. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>KeepOldHomePage</maml:name> <maml:description> <maml:para>Specifies if the current site home page is kept. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Owners</maml:name> <maml:description> <maml:para>The array of the UPN values of the group's owners.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the site to be connected to an Microsoft 365 Group. When not provided, the site currently being connected to will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Alias</maml:name> <maml:description> <maml:para>Specifies the alias of the group. Cannot contain spaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Classification</maml:name> <maml:description> <maml:para>Specifies the classification of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The optional description of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>HubSiteId</maml:name> <maml:description> <maml:para>If specified the site will be associated to the hubsite as identified by this id.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsPublic</maml:name> <maml:description> <maml:para>Specifies if the group is public. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>KeepOldHomePage</maml:name> <maml:description> <maml:para>Specifies if the current site home page is kept. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Owners</maml:name> <maml:description> <maml:para>The array of the UPN values of the group's owners.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the site to be connected to an Microsoft 365 Group. When not provided, the site currently being connected to will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPMicrosoft365GroupToSite -Url "https://contoso.sharepoint.com/sites/FinanceTeamsite" -Alias "FinanceTeamsite" -DisplayName "My finance team site group" ```</maml:para> <maml:para>This will groupify the FinanceTeamsite at the provided URL.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPMicrosoft365GroupToSite -Alias "HRTeamsite" -DisplayName "My HR team site group" ```</maml:para> <maml:para>This will groupify the currently connected site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPMicrosoft365GroupToSite -Url $SiteURL -Alias $GroupAlias -DisplayName $GroupName -IsPublic -KeepOldHomePage ``` This will groupify the $SiteURL site, make the Group public (default is Private) and keep the old Home page as the default homepage. The new Home.aspx is created but not set as default Homepage.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPNavigationNode</command:name> <maml:description> <maml:para>Adds an item to a navigation element</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPNavigationNode</command:noun> </command:details> <maml:description> <maml:para>Adds a menu item to either the quicklaunch, top navigation, search navigation or the footer</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPNavigationNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AudienceIds</maml:name> <maml:description> <maml:para>The Guids of the groups to which the navigation node should be visible. Leave empty to make the node visible to all users.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid array</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location where to add the navigation node to. Either TopNavigationBar, QuickLaunch, SearchNav or Footer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NavigationType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OpenInNewTab</maml:name> <maml:description> <maml:para>Indicates that the link will be opened in a new browser tab. This will only work if the navigation location is **QuickLaunch** due to SharePoint API limitation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Parent</maml:name> <maml:description> <maml:para>The parent navigation node. Leave empty to add to the top level</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">NavigationNodePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the node to add</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPNavigationNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AudienceIds</maml:name> <maml:description> <maml:para>The Guids of the groups to which the navigation node should be visible. Leave empty to make the node visible to all users.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid array</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location where to add the navigation node to. Either TopNavigationBar, QuickLaunch, SearchNav or Footer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NavigationType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OpenInNewTab</maml:name> <maml:description> <maml:para>Indicates that the link will be opened in a new browser tab. This will only work if the navigation location is **QuickLaunch** due to SharePoint API limitation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Parent</maml:name> <maml:description> <maml:para>The parent navigation node. Leave empty to add to the top level</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">NavigationNodePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the node to add</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AudienceIds</maml:name> <maml:description> <maml:para>The Guids of the groups to which the navigation node should be visible. Leave empty to make the node visible to all users.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid array</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location where to add the navigation node to. Either TopNavigationBar, QuickLaunch, SearchNav or Footer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NavigationType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OpenInNewTab</maml:name> <maml:description> <maml:para>Indicates that the link will be opened in a new browser tab. This will only work if the navigation location is **QuickLaunch** due to SharePoint API limitation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Parent</maml:name> <maml:description> <maml:para>The parent navigation node. Leave empty to add to the top level</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">NavigationNodePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PreviousNode</maml:name> <maml:description> <maml:para>Specifies the navigation node after which the new navigation node will appear in the navigation node collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NavigationNodePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the node to add</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPNavigationNode -Title "Contoso" -Url "http://contoso.sharepoint.com/sites/contoso/" -Location "QuickLaunch" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPNavigationNode -Title "Contoso USA" -Url "http://contoso.sharepoint.com/sites/contoso/usa/" -Location "QuickLaunch" -Parent 2012 ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPNavigationNode -Title "Contoso" -Url "http://contoso.sharepoint.com/sites/contoso/" -Location "QuickLaunch" -First ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPNavigationNode -Title "Contoso Pharmaceuticals" -Url "http://contoso.sharepoint.com/sites/contosopharma/" -Location "QuickLaunch" -External ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPNavigationNode -Title "Wiki" -Location "QuickLaunch" -Url "wiki/" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPNavigationNode -Title "Label" -Location "TopNavigationBar" -Url "http://linkless.header/" ```</maml:para> <maml:para>Adds a navigation node to the top navigation bar. The navigation node will be created as a label.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPNavigationNode -Title "Wiki" -Location "QuickLaunch" -Url "wiki/" -PreviousNode 2012 ``` Adds a navigation node to the quicklaunch. The navigation node will have the title "Wiki" and will link to the Wiki library on the selected Web after the node with the ID 2012.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.com" Add-PnPNavigationNode -Title "Marketing" -Url "https://contoso.sharepoint.com/sites/Marketing" -Location TopNavigationBar -External ``` Adds the Marketing navigation node to the top navigation bar on the root site. NOTE that the `-External` switch is mandatory as the connection is made to the root site. This is currently a CSOM issue but once fixed, it will be fixed in PnP PowerShell automatically.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 9 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPNavigationNode -Title "Contoso" -Url "http://contoso.sharepoint.com/sites/contoso/" -Location "QuickLaunch" -OpenInNewTab ```</maml:para> <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/". It will also open the link in a new tab.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPOrgAssetsLibrary</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Adds a given document library as an organizational asset source</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPOrgAssetsLibrary</command:noun> </command:details> <maml:description> <maml:para>Adds a given document library as an organizational asset source in your SharePoint Online Tenant. You can specify multiple libraries, but all organizational asset sources you add must reside in the same site collection.</maml:para> <maml:para>Document libraries specified as organizational asset must be enabled as an Office 365 CDN source, either as private or public.</maml:para> <maml:para>The libraries must also have read rights for 'Everyone except external users' enabled on them. Either on library or on the entire site level.</maml:para> <maml:para>Only entire libraries can be configured as an organizational asset, folders cannot.</maml:para> <maml:para>It may take some time before this change will be reflected in the web interface.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPOrgAssetsLibrary</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>Indicates what type of Office 365 CDN source the document library will be added to</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SPOTenantCdnType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DefaultOriginAdded</maml:name> <maml:description> <maml:para>Indicates that if the OFfice 365 CDN would not be enabled yet for the tenant, that it should be enabled and [the default origins](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide#default-cdn-origins) should be added to the tenant. This is only applicable when the CDN has not been enabled yet on the tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsCopilotSearchable</maml:name> <maml:description> <maml:para>Indicates that the organizational assets library should be searchable in the CoPilot search experience in Office applications to locate corporate images. Only works when the OrgAssetType is set to ImageDocumentLibrary.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LibraryUrl</maml:name> <maml:description> <maml:para>The full url of the document library to be marked as one of organization's assets sources</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OrgAssetType</maml:name> <maml:description> <maml:para>Indicates the type of content in this library.</maml:para> <maml:para>ImageDocumentLibrary is the default OrgAssetType and is best used for images. You can access the contents of this library from any site or page in the SharePoint filepicker. OfficeTemplateLibrary is the suggested type for Office files and will show up in the UI of all Office desktop apps and Office online in the templates section.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">OrgAssetType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>The full url to an image that should be used as a thumbnail for showing this source. The image must reside in the same site as the document library you specify.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>Indicates what type of Office 365 CDN source the document library will be added to</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SPOTenantCdnType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DefaultOriginAdded</maml:name> <maml:description> <maml:para>Indicates that if the OFfice 365 CDN would not be enabled yet for the tenant, that it should be enabled and [the default origins](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide#default-cdn-origins) should be added to the tenant. This is only applicable when the CDN has not been enabled yet on the tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsCopilotSearchable</maml:name> <maml:description> <maml:para>Indicates that the organizational assets library should be searchable in the CoPilot search experience in Office applications to locate corporate images. Only works when the OrgAssetType is set to ImageDocumentLibrary.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LibraryUrl</maml:name> <maml:description> <maml:para>The full url of the document library to be marked as one of organization's assets sources</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OrgAssetType</maml:name> <maml:description> <maml:para>Indicates the type of content in this library.</maml:para> <maml:para>ImageDocumentLibrary is the default OrgAssetType and is best used for images. You can access the contents of this library from any site or page in the SharePoint filepicker. OfficeTemplateLibrary is the suggested type for Office files and will show up in the UI of all Office desktop apps and Office online in the templates section.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">OrgAssetType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>The full url to an image that should be used as a thumbnail for showing this source. The image must reside in the same site as the document library you specify.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPOrgAssetsLibrary -LibraryUrl "https://yourtenant.sharepoint.com/sites/branding/logos" ```</maml:para> <maml:para>Adds the document library with the url "logos" located in the sitecollection at "https://yourtenant.sharepoint.com/sites/branding" as an organizational asset not specifying a thumbnail image for it and enabling the document library as a public Office 365 CDN source</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPOrgAssetsLibrary -LibraryUrl "https://yourtenant.sharepoint.com/sites/branding/logos" -ThumbnailUrl "https://yourtenant.sharepoint.com/sites/branding/logos/thumbnail.jpg" ```</maml:para> <maml:para>Adds the document library with the url "logos" located in the sitecollection at "https://yourtenant.sharepoint.com/sites/branding" as an organizational asset specifying the thumbnail image "thumbnail.jpg" residing in the same document library for it and enabling the document library as a public Office 365 CDN source</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPOrgAssetsLibrary -LibraryUrl "https://yourtenant.sharepoint.com/sites/branding/logos" -CdnType Private ```</maml:para> <maml:para>Adds the document library with the url "logos" located in the sitecollection at "https://yourtenant.sharepoint.com/sites/branding" as an organizational asset not specifying a thumbnail image for it and enabling the document library as a private Office 365 CDN source</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPOrgNewsSite</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Adds the site as an organization news source in your tenant</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPOrgNewsSite</command:noun> </command:details> <maml:description> <maml:para>Allows to add site as an organization news source in your tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPOrgNewsSite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OrgNewsSiteUrl</maml:name> <maml:description> <maml:para>The url of the site to be marked as one of organization's news sites</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OrgNewsSiteUrl</maml:name> <maml:description> <maml:para>The url of the site to be marked as one of organization's news sites</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPOrgNewsSite -OrgNewsSiteUrl "https://yourtenant.sharepoint.com/sites/news" ```</maml:para> <maml:para>Adds the site as one of multiple possible tenant's organizational news sites</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPPage</command:name> <maml:description> <maml:para>Creates a new page</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPPage</command:noun> </command:details> <maml:description> <maml:para>Creates a new page. The page will be located inside the Site Pages library of the site currently connected to. If the library does not exist yet, tries to ensure it is created.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CommentsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables the comments on the page.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>HeaderLayoutType</maml:name> <maml:description> <maml:para>Type of layout used for the header.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PageHeaderLayoutType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LayoutType</maml:name> <maml:description> <maml:para>Specifies the layout type of the page.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PageLayoutType</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the page. It will also be used to define the filename. I.e. if you provide MyPage, it will create a page MyPage.aspx inside the Site Pages library.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PromoteAs</maml:name> <maml:description> <maml:para>Allows to promote the page for a specific purpose (HomePage | NewsPage).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PagePromoteType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Publishes the page once it is saved. Applicable to libraries set to create major and minor versions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ScheduledPublishDate</maml:name> <maml:description> <maml:para>If provided, the page will be scheduled to be published on the provided date and time. It will enable page scheduling on the Site Pages library if not already enabled. If not provided, the publishing of the page will not be scheduled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Translate</maml:name> <maml:description> <maml:para>Creates multilingual pages for all the languages specified in the site collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TranslationLanguageCodes</maml:name> <maml:description> <maml:para>Creates multilingual pages for specified languages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Integer array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CommentsEnabled</maml:name> <maml:description> <maml:para>Enables or Disables the comments on the page.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>HeaderLayoutType</maml:name> <maml:description> <maml:para>Type of layout used for the header.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PageHeaderLayoutType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LayoutType</maml:name> <maml:description> <maml:para>Specifies the layout type of the page.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PageLayoutType</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the page. It will also be used to define the filename. I.e. if you provide MyPage, it will create a page MyPage.aspx inside the Site Pages library.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PromoteAs</maml:name> <maml:description> <maml:para>Allows to promote the page for a specific purpose (HomePage | NewsPage).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PagePromoteType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Publish</maml:name> <maml:description> <maml:para>Publishes the page once it is saved. Applicable to libraries set to create major and minor versions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ScheduledPublishDate</maml:name> <maml:description> <maml:para>If provided, the page will be scheduled to be published on the provided date and time. It will enable page scheduling on the Site Pages library if not already enabled. If not provided, the publishing of the page will not be scheduled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Translate</maml:name> <maml:description> <maml:para>Creates multilingual pages for all the languages specified in the site collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TranslationLanguageCodes</maml:name> <maml:description> <maml:para>Creates multilingual pages for specified languages.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Integer array</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPage -Name "NewPage" ```</maml:para> <maml:para>Creates a new page named 'NewPage'. The resulting file will accordingly be named 'NewPage.aspx'. If a file with that name already exists, executing the commandlet will fail.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPage -Name "NewPage" -Title "Welcome to my page" ```</maml:para> <maml:para>Creates a new page NewPage.aspx with the title as provided.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPage -Name "NewPage" -ContentType "MyPageContentType" ```</maml:para> <maml:para>Creates a new page named 'NewPage' and sets the content type to the content type specified.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPage -Name "NewPageTemplate" -PromoteAs Template ```</maml:para> <maml:para>Creates a new page named 'NewPage' and saves as a template to the site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPage -Name "Folder/NewPage" ```</maml:para> <maml:para>Creates a new page named 'NewPage' under 'Folder' folder and saves as a template to the site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPage -Name "NewPage" -HeaderLayoutType ColorBlock ```</maml:para> <maml:para>Creates a new page named 'NewPage' using the ColorBlock header layout.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPage -Name "NewPage" Article -ScheduledPublishDate (Get-Date).AddHours(1) ```</maml:para> <maml:para>Creates a new page named 'NewPage' using the article layout and schedule it to be published in 1 hour from now.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPage -Name "NewPage" -Translate ```</maml:para> <maml:para>Creates a new page named 'NewPage' and also creates the necessary translated page for the supported languages in the site collection.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 9 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPage -Name "NewPage" -Translate -TranslationLanguageCodes 1043 ```</maml:para> <maml:para>Creates a new page named 'NewPage' and also creates the necessary translated page for the specified language in the site collection. In this case, it will create the translated page for Dutch language. If the Dutch language is not enabled, it will enable the language and then create the translated page.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 10 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPage -Name "NewPage" -Translate -TranslationLanguageCodes 1043,1035 ```</maml:para> <maml:para>Creates a new page named 'NewPage' and also creates the necessary translated page for the specified languages in the site collection. In this case, it will create the translated pages for Dutch and Finnish languages. If these languages are not enabled, it will enable these languages and then create the translated pages for the specified languages.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPPageImageWebPart</command:name> <maml:description> <maml:para>Adds an image element to a client-side page.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPPageImageWebPart</command:noun> </command:details> <maml:description> <maml:para>Adds a new image element to a section on a client-side page.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPageImageWebPart</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AlternativeText</maml:name> <maml:description> <maml:para>Specifies the alt text to display for the image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Caption</maml:name> <maml:description> <maml:para>Specifies the caption text to display for the image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageHeight</maml:name> <maml:description> <maml:para>Specifies the height of the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageUrl</maml:name> <maml:description> <maml:para>Specifies the image to be added.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageWidth</maml:name> <maml:description> <maml:para>Specifies the width of the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Link</maml:name> <maml:description> <maml:para>Specifies the clickable link to display for the image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the image control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PageImageAlignment</maml:name> <maml:description> <maml:para>Specifies the inline image's alignment. Available values are Center, Left and Right.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PageImageAlignment</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPPageImageWebPart</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AlternativeText</maml:name> <maml:description> <maml:para>Specifies the alt text to display for the image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Caption</maml:name> <maml:description> <maml:para>Specifies the caption text to display for the image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Column</maml:name> <maml:description> <maml:para>Sets the column where to insert the image control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageHeight</maml:name> <maml:description> <maml:para>Specifies the height of the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageUrl</maml:name> <maml:description> <maml:para>Specifies the image to be added.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageWidth</maml:name> <maml:description> <maml:para>Specifies the width of the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Link</maml:name> <maml:description> <maml:para>Specifies the clickable link to display for the image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the image control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PageImageAlignment</maml:name> <maml:description> <maml:para>Specifies the inline image's alignment. Available values are Center, Left and Right.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PageImageAlignment</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Section</maml:name> <maml:description> <maml:para>Sets the section where to insert the image control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AlternativeText</maml:name> <maml:description> <maml:para>Specifies the alt text to display for the image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Caption</maml:name> <maml:description> <maml:para>Specifies the caption text to display for the image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Column</maml:name> <maml:description> <maml:para>Sets the column where to insert the image control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageHeight</maml:name> <maml:description> <maml:para>Specifies the height of the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageUrl</maml:name> <maml:description> <maml:para>Specifies the image to be added.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageWidth</maml:name> <maml:description> <maml:para>Specifies the width of the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Link</maml:name> <maml:description> <maml:para>Specifies the clickable link to display for the image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the image control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PageImageAlignment</maml:name> <maml:description> <maml:para>Specifies the inline image's alignment. Available values are Center, Left and Right.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PageImageAlignment</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Section</maml:name> <maml:description> <maml:para>Sets the section where to insert the image control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPageImageWebPart -Page "MyPage" -ImageUrl "/sites/contoso/siteassets/test.png" ```</maml:para> <maml:para>Adds the image with specified URL to the Page 'MyPage'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPageImageWebPart -Page "MyPage" -ImageUrl "/sites/contoso/SiteAssets/test.png" -ImageWidth 400 -ImageHeight 200 -Caption "Caption text" -AlternativeText "Alt text" -Link "https://pnp.github.io" ```</maml:para> <maml:para>Adds the image with specified URL to the Page 'MyPage' with width, height, caption, alt text and link parameters.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPPageSection</command:name> <maml:description> <maml:para>Adds a new section to a page.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPPageSection</command:noun> </command:details> <maml:description> <maml:para>Allows to add a new section to a page.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPageSection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the section. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page or the page object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SectionTemplate</maml:name> <maml:description> <maml:para>Specifies the columns template to use for the section.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CanvasSectionTemplate</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>VerticalZoneEmphasis</maml:name> <maml:description> <maml:para>Sets the background of the vertical section (default = 0). Works only for vertical column layouts, will be ignored for other layouts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ZoneEmphasis</maml:name> <maml:description> <maml:para>Sets the background of the section (default = 0).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the section. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page or the page object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SectionTemplate</maml:name> <maml:description> <maml:para>Specifies the columns template to use for the section.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">CanvasSectionTemplate</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>VerticalZoneEmphasis</maml:name> <maml:description> <maml:para>Sets the background of the vertical section (default = 0). Works only for vertical column layouts, will be ignored for other layouts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ZoneEmphasis</maml:name> <maml:description> <maml:para>Sets the background of the section (default = 0).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPageSection -Page "MyPage" -SectionTemplate OneColumn ```</maml:para> <maml:para>Adds a new one-column section to the page 'MyPage'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPageSection -Page "MyPage" -SectionTemplate ThreeColumn -Order 10 ```</maml:para> <maml:para>Adds a new Three columns section to the page 'MyPage' with an order index of 10.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell $page = Add-PnPPage -Name "MyPage" Add-PnPPageSection -Page $page -SectionTemplate OneColumn ```</maml:para> <maml:para>Adds a new one column section to the page 'MyPage'.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell $page = Add-PnPPage -Name "MyPage" Add-PnPPageSection -Page $page -SectionTemplate OneColumn -ZoneEmphasis 2 ```</maml:para> <maml:para>Adds a new one column section to the page 'MyPage' and sets the background to 2 (0 is no background, 3 is highest emphasis).</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell $page = Add-PnPPage -Name "MyPage" Add-PnPPageSection -Page $page -SectionTemplate OneColumnVerticalSection -Order 1 -ZoneEmphasis 2 -VerticalZoneEmphasis 3 ```</maml:para> <maml:para>Adds a new one column with one vertical section to the page 'MyPage' and sets the zone emphasis to 2 for one column and vertical zone emphasis to 3 for the vertical column.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPPageTextPart</command:name> <maml:description> <maml:para>Adds a text element to a client-side page.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPPageTextPart</command:noun> </command:details> <maml:description> <maml:para>Adds a new text element to a section on a client-side page.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPageTextPart</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageHeight</maml:name> <maml:description> <maml:para>Specifies the height of the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageUrl</maml:name> <maml:description> <maml:para>Specifies the inline image to be added. Image will be added after the text content.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageWidth</maml:name> <maml:description> <maml:para>Specifies the width of the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the text control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PageImageAlignment</maml:name> <maml:description> <maml:para>Specifies the inline image's alignment. Available values are Center, Left and Right.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PageImageAlignment</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies the text to display in the text area.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TextAfterImage</maml:name> <maml:description> <maml:para>Specifies the text to display after the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TextBeforeImage</maml:name> <maml:description> <maml:para>Specifies the text to display before the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPPageTextPart</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Column</maml:name> <maml:description> <maml:para>Sets the column where to insert the text control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageHeight</maml:name> <maml:description> <maml:para>Specifies the height of the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageUrl</maml:name> <maml:description> <maml:para>Specifies the inline image to be added. Image will be added after the text content.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageWidth</maml:name> <maml:description> <maml:para>Specifies the width of the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the text control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PageImageAlignment</maml:name> <maml:description> <maml:para>Specifies the inline image's alignment. Available values are Center, Left and Right.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PageImageAlignment</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Section</maml:name> <maml:description> <maml:para>Sets the section where to insert the text control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies the text to display in the text area.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TextAfterImage</maml:name> <maml:description> <maml:para>Specifies the text to display after the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TextBeforeImage</maml:name> <maml:description> <maml:para>Specifies the text to display before the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Column</maml:name> <maml:description> <maml:para>Sets the column where to insert the text control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageHeight</maml:name> <maml:description> <maml:para>Specifies the height of the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageUrl</maml:name> <maml:description> <maml:para>Specifies the inline image to be added. Image will be added after the text content.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ImageWidth</maml:name> <maml:description> <maml:para>Specifies the width of the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the text control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PageImageAlignment</maml:name> <maml:description> <maml:para>Specifies the inline image's alignment. Available values are Center, Left and Right.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PageImageAlignment</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Section</maml:name> <maml:description> <maml:para>Sets the section where to insert the text control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Text</maml:name> <maml:description> <maml:para>Specifies the text to display in the text area.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TextAfterImage</maml:name> <maml:description> <maml:para>Specifies the text to display after the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TextBeforeImage</maml:name> <maml:description> <maml:para>Specifies the text to display before the inline image.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPageTextPart -Page "MyPage" -Text "Hello World!" ```</maml:para> <maml:para>Adds the text 'Hello World!' to the Page 'MyPage'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPageTextPart -Page "MyPage" -Text "Hello World!" -ImageUrl "/sites/contoso/SiteAssets/test.png" ```</maml:para> <maml:para>Adds the text 'Hello World!' to the Page 'MyPage' with specified image as inline image.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPageTextPart -Page "MyPage" -Text "Hello World!" -ImageUrl "/sites/contoso/SiteAssets/test.png" -TextBeforeImage "Text before" -TextAfterImage "Text after" ```</maml:para> <maml:para>Adds the text 'Hello World!' to the Page 'MyPage' with specified image as inline image with text specified before and after the inline image.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPPageWebPart</command:name> <maml:description> <maml:para>Adds a web part to a page</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPPageWebPart</command:noun> </command:details> <maml:description> <maml:para>Adds a client-side web part to an existing client-side page.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPageWebPart</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DefaultWebPartType</maml:name> <maml:description> <maml:para>Defines a default web part type to insert.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DefaultClientSideWebParts</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the web part control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebPartProperties</maml:name> <maml:description> <maml:para>The properties of the web part</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PropertyBagPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPPageWebPart</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Component</maml:name> <maml:description> <maml:para>Specifies the component instance or Id to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PageComponentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the web part control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebPartProperties</maml:name> <maml:description> <maml:para>The properties of the web part</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PropertyBagPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPPageWebPart</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Column</maml:name> <maml:description> <maml:para>Sets the column where to insert the web part control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DefaultWebPartType</maml:name> <maml:description> <maml:para>Defines a default web part type to insert.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DefaultClientSideWebParts</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the web part control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Section</maml:name> <maml:description> <maml:para>Sets the section where to insert the web part control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebPartProperties</maml:name> <maml:description> <maml:para>The properties of the web part</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PropertyBagPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPPageWebPart</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Column</maml:name> <maml:description> <maml:para>Sets the column where to insert the web part control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Component</maml:name> <maml:description> <maml:para>Specifies the component instance or Id to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PageComponentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the web part control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Section</maml:name> <maml:description> <maml:para>Sets the section where to insert the web part control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebPartProperties</maml:name> <maml:description> <maml:para>The properties of the web part</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PropertyBagPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Column</maml:name> <maml:description> <maml:para>Sets the column where to insert the web part control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Component</maml:name> <maml:description> <maml:para>Specifies the component instance or Id to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PageComponentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DefaultWebPartType</maml:name> <maml:description> <maml:para>Defines a default web part type to insert.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DefaultClientSideWebParts</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>Sets the order of the web part control. (Default = 1)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Section</maml:name> <maml:description> <maml:para>Sets the section where to insert the web part control.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebPartProperties</maml:name> <maml:description> <maml:para>The properties of the web part</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PropertyBagPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPageWebPart -Page "MyPage" -DefaultWebPartType BingMap ```</maml:para> <maml:para>Adds a built-in component 'BingMap' to the page called 'MyPage'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPageWebPart -Page "MyPage" -Component "HelloWorld" ```</maml:para> <maml:para>Adds a component 'HelloWorld' to the page called 'MyPage'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPageWebPart -Page "MyPage" -Component "HelloWorld" -Section 1 -Column 2 ```</maml:para> <maml:para>Adds a component 'HelloWorld' to the page called 'MyPage' in section 1 and column 2</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPPlannerBucket</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: One of Tasks.ReadWrite, Tasks.ReadWrite.All, Group.ReadWrite.All, Adds a new bucket to a Planner plan</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPPlannerBucket</command:noun> </command:details> <maml:description> <maml:para>This cmdlets creates a new bucket for tasks in a Planner plan.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPlannerBucket</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specify the group id or group name of the group owning the plan.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to add</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Plan</maml:name> <maml:description> <maml:para>Specify the id or name of the plan to add the tasks to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerPlanPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPPlannerBucket</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to add</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PlanId</maml:name> <maml:description> <maml:para>A plan id to add the bucket to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specify the group id or group name of the group owning the plan.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to add</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Plan</maml:name> <maml:description> <maml:para>Specify the id or name of the plan to add the tasks to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerPlanPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PlanId</maml:name> <maml:description> <maml:para>A plan id to add the bucket to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPlannerBucket -Group "My Group" -Plan "My Plan" -Name "Project Todos" ```</maml:para> <maml:para>Adds a new bucket called "Project Todos" to the specified plans</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPlannerBucket -PlanId "QvfkTd1mc02gwxHjHC_43JYABhAy" -Name "Project Todos" ```</maml:para> <maml:para>Adds a new bucket called "Project Todos" to the plan with the specified id.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPPlannerRoster</command:name> <maml:description> <maml:para>Creates a new Microsoft Planner Roster</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPPlannerRoster</command:noun> </command:details> <maml:description> <maml:para>Creates a new Microsoft Planner Roster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPlannerRoster</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPlannerRoster ```</maml:para> <maml:para>Creates a new Microsoft Planner Roster</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPPlannerRosterMember</command:name> <maml:description> <maml:para>Adds a user to an existing Microsoft Planner Roster</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPPlannerRosterMember</command:noun> </command:details> <maml:description> <maml:para>Adds a user to an existing Microsoft Planner Roster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPlannerRosterMember</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the Microsoft Planner Roster to add the member to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerRosterPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User principal name of the user to add as a member</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the Microsoft Planner Roster to add the member to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerRosterPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User principal name of the user to add as a member</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPlannerRosterMember -Identity "6519868f-868f-6519-8f86-19658f861965" -User "johndoe@contoso.onmicrosoft.com" ```</maml:para> <maml:para>Creates a new Microsoft Planner Roster</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPPlannerTask</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: One of Tasks.ReadWrite, Tasks.ReadWrite.All, Group.ReadWrite.All Adds a new task to a planner bucket</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPPlannerTask</command:noun> </command:details> <maml:description> <maml:para>This cmdlet adds a new task to Planner bucket</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPlannerTask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AppliedCategories</maml:name> <maml:description> <maml:para>The applied categories represent the labels as shown in the UI of the planner task. Categories are 'hardcoded' as such in Planner, e.g. you can set Category1 to Category25, each having its own color. Labels, if customized in planner will be set accordingly to the ones defined. You can either copy the value from an existing task (e.g. $task = Get-PnPPlannerTask, Add-PnPPlannerTask -PlanId <yourid> -AppliedCategories $task.AppliedCategory) or you can define it as a new object: @{"Category1"=$true,"Category5"=$true}. Notice that omitting a category from the data you send in will -not- reset that category. E.g. if you want to remove a category/label from a task you will have to explicitly set it to $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AppliedCategories</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssignedTo</maml:name> <maml:description> <maml:para>Specify the email(s) of the user to assign the task to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The bucket to add the task too</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerBucketPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Sets the description (notes) of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DueDateTime</maml:name> <maml:description> <maml:para>Specify the due date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specify the group id or name of the group owning the plan.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OutputTask</maml:name> <maml:description> <maml:para>Returns the just created task as an object to inspect values</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PercentComplete</maml:name> <maml:description> <maml:para>Defines the percentage of completeness of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Plan</maml:name> <maml:description> <maml:para>Specify the id or name of the plan to add the tasks to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerPlanPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Sets the priority of the task. Value should be a number between 0 and 10. - values 0 and 1 are interpreted as _Urgent_ - values 2, 3 and 4 are interpreted as _Important_ - values 5, 6 and 7 are interpreted as _Medium_ - values 8, 9 and 10 are interpreted as _Low_</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Defines the start date of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specify the title of the task</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPPlannerTask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AppliedCategories</maml:name> <maml:description> <maml:para>The applied categories represent the labels as shown in the UI of the planner task. Categories are 'hardcoded' as such in Planner, e.g. you can set Category1 to Category25, each having its own color. Labels, if customized in planner will be set accordingly to the ones defined. You can either copy the value from an existing task (e.g. $task = Get-PnPPlannerTask, Add-PnPPlannerTask -PlanId <yourid> -AppliedCategories $task.AppliedCategory) or you can define it as a new object: @{"Category1"=$true,"Category5"=$true}. Notice that omitting a category from the data you send in will -not- reset that category. E.g. if you want to remove a category/label from a task you will have to explicitly set it to $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AppliedCategories</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssignedTo</maml:name> <maml:description> <maml:para>Specify the email(s) of the user to assign the task to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The bucket to add the task too</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerBucketPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Sets the description (notes) of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DueDateTime</maml:name> <maml:description> <maml:para>Specify the due date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OutputTask</maml:name> <maml:description> <maml:para>Returns the just created task as an object to inspect values</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PercentComplete</maml:name> <maml:description> <maml:para>Defines the percentage of completeness of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PlanId</maml:name> <maml:description> <maml:para>Specify the id the plan to add the tasks to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Sets the priority of the task. Value should be a number between 0 and 10. - values 0 and 1 are interpreted as _Urgent_ - values 2, 3 and 4 are interpreted as _Important_ - values 5, 6 and 7 are interpreted as _Medium_ - values 8, 9 and 10 are interpreted as _Low_</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Defines the start date of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specify the title of the task</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AppliedCategories</maml:name> <maml:description> <maml:para>The applied categories represent the labels as shown in the UI of the planner task. Categories are 'hardcoded' as such in Planner, e.g. you can set Category1 to Category25, each having its own color. Labels, if customized in planner will be set accordingly to the ones defined. You can either copy the value from an existing task (e.g. $task = Get-PnPPlannerTask, Add-PnPPlannerTask -PlanId <yourid> -AppliedCategories $task.AppliedCategory) or you can define it as a new object: @{"Category1"=$true,"Category5"=$true}. Notice that omitting a category from the data you send in will -not- reset that category. E.g. if you want to remove a category/label from a task you will have to explicitly set it to $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AppliedCategories</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssignedTo</maml:name> <maml:description> <maml:para>Specify the email(s) of the user to assign the task to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The bucket to add the task too</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerBucketPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Sets the description (notes) of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DueDateTime</maml:name> <maml:description> <maml:para>Specify the due date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specify the group id or name of the group owning the plan.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OutputTask</maml:name> <maml:description> <maml:para>Returns the just created task as an object to inspect values</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PercentComplete</maml:name> <maml:description> <maml:para>Defines the percentage of completeness of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Plan</maml:name> <maml:description> <maml:para>Specify the id or name of the plan to add the tasks to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerPlanPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PlanId</maml:name> <maml:description> <maml:para>Specify the id the plan to add the tasks to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Sets the priority of the task. Value should be a number between 0 and 10. - values 0 and 1 are interpreted as _Urgent_ - values 2, 3 and 4 are interpreted as _Important_ - values 5, 6 and 7 are interpreted as _Medium_ - values 8, 9 and 10 are interpreted as _Low_</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Defines the start date of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Specify the title of the task</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPlannerTask -Group "Marketing" -Plan "Conference Plan" -Bucket "Todos" -Title "Design booth layout" -AppliedCategories @{"Category1"=$true,"Category3"=$true} ```</maml:para> <maml:para>This cmdlet adds a new task.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPlannerTask -PlanId "QvfkTd1mc02gwxHjHC_43JYABhAy" -Bucket "Todos" -Title "Design booth layout" -AppliedCategories @{"Category1"=$true,"Category3"=$true} ```</maml:para> <maml:para>This cmdlet adds a new task.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPlannerTask -Group "Marketing" -Plan "Conference Plan" -Bucket "Todos" -Title "Design booth layout" -AssignedTo "user@contoso.com","manager@contoso.com" -AppliedCategories @{"Category1"=$true,"Category3"=$true} ```</maml:para> <maml:para>This cmdlet adds a new task and assigns to user@contoso.com and manager@contoso.com</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell $task = Add-PnPPlannerTask -Group "Marketing" -Plan "Conference Plan" -Bucket "Todos" -Title "Design booth layout" -AssignedTo "user@contoso.com","manager@contoso.com" -OutputTask ```</maml:para> <maml:para>This returns the task as an object to inspect specific values</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Add</command:verb> <command:noun>PnPPublishingImageRendition</command:noun> </command:details> <maml:description> <maml:para>Allows to add an Image Rendition.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPublishingImageRendition</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Height</maml:name> <maml:description> <maml:para>The height of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The display name of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Width</maml:name> <maml:description> <maml:para>The width of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Height</maml:name> <maml:description> <maml:para>The height of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The display name of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Width</maml:name> <maml:description> <maml:para>The width of the Image Rendition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPublishingImageRendition -Name "MyImageRendition" -Width 800 -Height 600 ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPPublishingPage</command:name> <maml:description> <maml:para>Adds a publishing page</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPPublishingPage</command:noun> </command:details> <maml:description> <maml:para>Allows to add a publishing page.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPublishingPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPublishingPage -PageName 'OurNewPage' -Title 'Our new page' -PageTemplateName 'ArticleLeft' ```</maml:para> <maml:para>Creates a new page based on the pagelayout 'ArticleLeft'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPublishingPage -PageName 'OurNewPage' -Title 'Our new page' -PageTemplateName 'ArticleLeft' -Folder '/Pages/folder' ```</maml:para> <maml:para>Creates a new page based on the pagelayout 'ArticleLeft' with a site relative folder path</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPPublishingPageLayout</command:name> <maml:description> <maml:para>Adds a publishing page layout</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPPublishingPageLayout</command:noun> </command:details> <maml:description> <maml:para>Allows to add a publishing page layout and associate it to a content type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPPublishingPageLayout</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssociatedContentTypeID</maml:name> <maml:description> <maml:para>Associated content type ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssociatedContentTypeID</maml:name> <maml:description> <maml:para>Associated content type ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description for the page layout</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title for the page layout</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPPublishingPageLayout -Title 'Our custom page layout' -SourceFilePath 'customlayout.aspx' -Description 'A custom page layout' -AssociatedContentTypeID 0x01010901 ```</maml:para> <maml:para>Uploads the pagelayout 'customlayout.aspx' to the current site as a 'web part page' pagelayout</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPRoleDefinition</command:name> <maml:description> <maml:para>Adds a Role Definition (Permission Level) to the site collection in the current context</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPRoleDefinition</command:noun> </command:details> <maml:description> <maml:para>This command allows adding a custom Role Definition (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="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">RoleDefinitionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description for the new permission level.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Exclude</maml:name> <maml:description> <maml:para>Specifies permission flag(s) to disable. Please visit https://learn.microsoft.com/previous-versions/office/sharepoint-csom/ee536458(v%3Doffice.15) for the PermissionKind enum</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PermissionKind[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Include</maml:name> <maml:description> <maml:para>Specifies permission flag(s) to enable. Please visit https://learn.microsoft.com/previous-versions/office/sharepoint-csom/ee536458(v%3Doffice.15) for the PermissionKind enum</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PermissionKind[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Name of new permission level.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">RoleDefinitionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description for the new permission level.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Exclude</maml:name> <maml:description> <maml:para>Specifies permission flag(s) to disable. Please visit https://learn.microsoft.com/previous-versions/office/sharepoint-csom/ee536458(v%3Doffice.15) for the PermissionKind enum</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PermissionKind[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Include</maml:name> <maml:description> <maml:para>Specifies permission flag(s) to enable. Please visit https://learn.microsoft.com/previous-versions/office/sharepoint-csom/ee536458(v%3Doffice.15) for the PermissionKind enum</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PermissionKind[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Name of new permission level.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPRoleDefinition -RoleName "CustomPerm" ```</maml:para> <maml:para>Creates additional permission level with no permission flags enabled.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPRoleDefinition -RoleName "NoDelete" -Clone "Contribute" -Exclude DeleteListItems ```</maml:para> <maml:para>Creates additional permission level by cloning "Contribute" and removes flags DeleteListItems</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPRoleDefinition -RoleName "AddOnly" -Clone "Contribute" -Exclude DeleteListItems, EditListItems ```</maml:para> <maml:para>Creates additional permission level by cloning "Contribute" and removes flags DeleteListItems and EditListItems</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell $roleDefinition = Get-PnPRoleDefinition -Identity "Contribute" Add-PnPRoleDefinition -RoleName "AddOnly" -Clone $roleDefinition -Exclude DeleteListItems, EditListItems ```</maml:para> <maml:para>Creates additional permission level by cloning "Contribute" and removes flags DeleteListItems and EditListItems</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Add</command:verb> <command:noun>PnPSiteCollectionAdmin</command:noun> </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. You must be a Site Collection Admin to run this command. Use `Set-PnPTenantSite -Owners` if you are not an Admin for the site but have the SharePoint Online admin role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteCollectionAdmin</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies owner(s) to add as site collection administrators. They will be added as additional secondary 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="false" variableLength="true">System.Collections.Generic.List`1[PnP.PowerShell.Commands.Base.PipeBinds.UserPipeBind]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PrimarySiteCollectionAdmin</maml:name> <maml:description> <maml:para>The user to set as the primary site collection administrator. This will replace the current primary site collection administrator. To add additional site collection administrators, use the -Owners parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.PowerShell.Commands.Base.PipeBinds.UserPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Owners</maml:name> <maml:description> <maml:para>Specifies owner(s) to add as site collection administrators. They will be added as additional secondary 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="false" variableLength="true">System.Collections.Generic.List`1[PnP.PowerShell.Commands.Base.PipeBinds.UserPipeBind]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PrimarySiteCollectionAdmin</maml:name> <maml:description> <maml:para>The user to set as the primary site collection administrator. This will replace the current primary site collection administrator. To add additional site collection administrators, use the -Owners parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnP.PowerShell.Commands.Base.PipeBinds.UserPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteCollectionAdmin -Owners "user@contoso.onmicrosoft.com" ```</maml:para> <maml:para>This will add user@contoso.onmicrosoft.com as an additional secondary site collection administrator to the site collection in the current context</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteCollectionAdmin -Owners @("user1@contoso.onmicrosoft.com", "user2@contoso.onmicrosoft.com") ```</maml:para> <maml:para>This will add user1@contoso.onmicrosoft.com and user2@contoso.onmicrosoft.com as additional secondary site collection administrator to the site collection in the current context</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPUser | Where-Object Title -Like "*Doe" | Add-PnPSiteCollectionAdmin ```</maml:para> <maml:para>This will add all users with their title ending with "Doe" as additional secondary site collection administrators to the site collection in the current context</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteCollectionAdmin -PrimarySiteCollectionAdmin "user@contoso.onmicrosoft.com" ```</maml:para> <maml:para>This will set user@contoso.onmicrosoft.com as the primary site collection administrator of the site collection in the current context</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPSiteCollectionAppCatalog</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Adds a Site Collection scoped App Catalog to a site</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPSiteCollectionAppCatalog</command:noun> </command:details> <maml:description> <maml:para>Allows to add Site Collection scoped App Catalog.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteCollectionAppCatalog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>Url of the site to add the app catalog to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>Url of the site to add the app catalog to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteCollectionAppCatalog ```</maml:para> <maml:para>This will add a SiteCollection app catalog to the currently connected to site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteCollectionAppCatalog -Site "https://contoso.sharepoint.com/sites/FinanceTeamsite" ```</maml:para> <maml:para>This will add a SiteCollection app catalog to the specified site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/sharepoint/dev/general-development/site-collection-app-catalog#configure-and-manage-site-collection-app-catalogs</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPSiteDesign</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Creates a new Site Design on the current tenant</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPSiteDesign</command:noun> </command:details> <maml:description> <maml:para>Allows to add a new Site Design on the current tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteDesign</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DesignPackageId</maml:name> <maml:description> <maml:para>Sets the design package Id of this site design.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Specifies that the site design is a default site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PreviewImageAltText</maml:name> <maml:description> <maml:para>Sets the text for the preview image. This was used in the old site designs approach and currently has no function anymore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PreviewImageUrl</maml:name> <maml:description> <maml:para>Sets the url to the preview image. This was used in the old site designs approach and currently has no function anymore. Use ThumbnailUrl instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteScript</maml:name> <maml:description> <maml:para>An instance, id or title of a site script to use for the site design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TenantSiteScriptPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>The full URL of a thumbnail image, i.e. https://contoso.sharepoint/siteassets/image.png. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels. This is the image that will be shown when selecting a template through "Apply a site template" or "Browse templates" shown in "Start designing your site" shown when creating a new site. If there are spaces in the URL, do not URL encode them, so i.e. do not use %20 where there is a space, but instead just provide the link with the space inside.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebTemplate</maml:name> <maml:description> <maml:para>Specifies the type of site to which this design applies</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteWebTemplate</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPSiteDesign</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DesignPackageId</maml:name> <maml:description> <maml:para>Sets the design package Id of this site design.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Specifies that the site design is a default site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PreviewImageAltText</maml:name> <maml:description> <maml:para>Sets the text for the preview image. This was used in the old site designs approach and currently has no function anymore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PreviewImageUrl</maml:name> <maml:description> <maml:para>Sets the url to the preview image. This was used in the old site designs approach and currently has no function anymore. Use ThumbnailUrl instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteScriptIds</maml:name> <maml:description> <maml:para>An array of guids of site scripts to use for the site design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>The full URL of a thumbnail image, i.e. https://contoso.sharepoint/siteassets/image.png. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels. This is the image that will be shown when selecting a template through "Apply a site template" or "Browse templates" shown in "Start designing your site" shown when creating a new site. If there are spaces in the URL, do not URL encode them, so i.e. do not use %20 where there is a space, but instead just provide the link with the space inside.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebTemplate</maml:name> <maml:description> <maml:para>Specifies the type of site to which this design applies</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteWebTemplate</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DesignPackageId</maml:name> <maml:description> <maml:para>Sets the design package Id of this site design.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Specifies that the site design is a default site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PreviewImageAltText</maml:name> <maml:description> <maml:para>Sets the text for the preview image. This was used in the old site designs approach and currently has no function anymore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PreviewImageUrl</maml:name> <maml:description> <maml:para>Sets the url to the preview image. This was used in the old site designs approach and currently has no function anymore. Use ThumbnailUrl instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteScript</maml:name> <maml:description> <maml:para>An instance, id or title of a site script to use for the site design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TenantSiteScriptPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteScriptIds</maml:name> <maml:description> <maml:para>An array of guids of site scripts to use for the site design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>The full URL of a thumbnail image, i.e. https://contoso.sharepoint/siteassets/image.png. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels. This is the image that will be shown when selecting a template through "Apply a site template" or "Browse templates" shown in "Start designing your site" shown when creating a new site. If there are spaces in the URL, do not URL encode them, so i.e. do not use %20 where there is a space, but instead just provide the link with the space inside.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebTemplate</maml:name> <maml:description> <maml:para>Specifies the type of site to which this design applies</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteWebTemplate</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteDesign -Title "My Company Design" -SiteScriptIds "e84dcb46-3ab9-4456-a136-66fc6ae3d3c5","6def687f-0e08-4f1e-999c-791f3af9a600" -Description "My description" -WebTemplate TeamSite ```</maml:para> <maml:para>Adds a new Site Design, with the specified title and description. When applied it will run the scripts as referenced by the IDs. Use Get-PnPSiteScript to receive Site Scripts. The WebTemplate parameter specifies that this design applies to modern Team Sites.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteDesign -Title "My Company Design" -SiteScriptIds "e84dcb46-3ab9-4456-a136-66fc6ae3d3c5","6def687f-0e08-4f1e-999c-791f3af9a600" -Description "My description" -WebTemplate TeamSite -ThumbnailUrl https://contoso.sharepoint.com/sites/templates/siteassets/logo.png ```</maml:para> <maml:para>Adds a new Site Design, with the specified title, description and logo to be shown in the template picker. When applied it will run the scripts as referenced by the IDs. Use Get-PnPSiteScript to receive Site Scripts. The WebTemplate parameter specifies that this design applies to modern Team Sites.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteDesign -Title "My Company Design" -SiteScriptIds "e84dcb46-3ab9-4456-a136-66fc6ae3d3c5","6def687f-0e08-4f1e-999c-791f3af9a600" -Description "My description" -WebTemplate TeamSite -ThumbnailUrl "https://contoso.sharepoint.com/sites/templates/my images/logo.png" ```</maml:para> <maml:para>Adds a new Site Design, with the specified title, description and logo to be shown in the template picker. When applied it will run the scripts as referenced by the IDs. Use Get-PnPSiteScript to receive Site Scripts. The WebTemplate parameter specifies that this design applies to modern Team Sites. Notice that when the location for the ThumbnailUrl contains a space, it should be provided URL decoded, so i.e. no %20 for spaces.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteScriptFromWeb -IncludeAll | Add-PnPSiteScript -Title "My Site Script" | Add-PnPSiteDesign -Title "My Site Design" -WebTemplate TeamSite ```</maml:para> <maml:para>Adds a new Site Design based on the currently connected to site, with the specified title to be shown in the template picker.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPSiteDesignFromWeb</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Creates a new Site Design on the current tenant based on the site provided through -Url or the currently connected to site if -Url is omitted</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPSiteDesignFromWeb</command:noun> </command:details> <maml:description> <maml:para>Creates a new Site Design on the current tenant based on the site provided through -Url or the currently connected to site if -Url is omitted. It combines the steps of `Get-PnPSiteScriptFromWeb`, `Add-PnPSiteScript` and `Add-PnPSiteDesign` into one cmdlet. The information returned from running the cmdlet is the information of the Site Design that has been created.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteDesignFromWeb</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DesignPackageId</maml:name> <maml:description> <maml:para>Sets the design package Id of this site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SiteWebTemplate</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Specifies if the site design is a default site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Lists</maml:name> <maml:description> <maml:para>Allows specifying one or more site relative URLs of lists that should be included into the Site Script, i.e. "Shared Documents","List\MyList"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PreviewImageAltText</maml:name> <maml:description> <maml:para>Sets the text for the preview image. This was used in the old site designs approach and currently has no function anymore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PreviewImageUrl</maml:name> <maml:description> <maml:para>Sets the url to the preview image. This was used in the old site designs approach and currently has no function anymore. Use ThumbnailUrl instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>The full URL of a thumbnail image, i.e. https://contoso.sharepoint/siteassets/image.png. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels. This is the image that will be shown when selecting a template through "Apply a site template" or "Browse templates" shown in "Start designing your site" shown when creating a new site.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebTemplate</maml:name> <maml:description> <maml:para>Specifies the type of site to which this design applies</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteWebTemplate</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DesignPackageId</maml:name> <maml:description> <maml:para>Sets the design package Id of this site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SiteWebTemplate</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeAll</maml:name> <maml:description> <maml:para>If specified will include all supported components into the Site Script except for the lists and document libraries, these need to be explicitly be specified through -Lists</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeBranding</maml:name> <maml:description> <maml:para>If specified will include the branding of the site into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeLinksToExportedItems</maml:name> <maml:description> <maml:para>If specified will include navigation links into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeRegionalSettings</maml:name> <maml:description> <maml:para>If specified will include the regional settings into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSiteExternalSharingCapability</maml:name> <maml:description> <maml:para>If specified will include the external sharing configuration into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeTheme</maml:name> <maml:description> <maml:para>If specified will include the branding of the site into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Specifies if the site design is a default site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Lists</maml:name> <maml:description> <maml:para>Allows specifying one or more site relative URLs of lists that should be included into the Site Script, i.e. "Shared Documents","List\MyList"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PreviewImageAltText</maml:name> <maml:description> <maml:para>Sets the text for the preview image. This was used in the old site designs approach and currently has no function anymore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PreviewImageUrl</maml:name> <maml:description> <maml:para>Sets the url to the preview image. This was used in the old site designs approach and currently has no function anymore. Use ThumbnailUrl instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ThumbnailUrl</maml:name> <maml:description> <maml:para>The full URL of a thumbnail image, i.e. https://contoso.sharepoint/siteassets/image.png. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels. This is the image that will be shown when selecting a template through "Apply a site template" or "Browse templates" shown in "Start designing your site" shown when creating a new site.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site design</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebTemplate</maml:name> <maml:description> <maml:para>Specifies the type of site to which this design applies</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteWebTemplate</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteDesignFromWeb -Title "My Company Design" -Description "My description" -WebTemplate TeamSite -IncludeAll ```</maml:para> <maml:para>Generates a site script based on all the components of the currently connected to site, excluding its lists and libraries and based on the generated script it will create a site script and a site design with the specified title and description for modern team sites.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteDesignFromWeb -Title "My Company Design" -Description "My description" -WebTemplate TeamSite -IncludeAll -Lists ("/lists/Issue list", "Shared Documents) ```</maml:para> <maml:para>Generates a site script based on all the components of the currently connected to site, including the list "Issue list" and the default document library "Shared Documents" and based on the generated script it will create a site script and a site design with the specified title and description for modern team sites.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteDesignFromWeb -Title "My Company Design" -Description "My description" -WebTemplate TeamSite -Lists "/lists/Issue list" -ThumbnailUrl https://contoso.sharepoint.com/SiteAssets/logo.png ```</maml:para> <maml:para>Generates a site script based on the list "Issue list" in the current site and based on the generated script it will create a site script and a site design with the specified title, description and logo for modern team sites.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPSiteDesignTask</command:name> <maml:description> <maml:para>This command is used to apply a published site design to a specified site collection target. It schedules the operation, allowing for the application of larger site scripts (Invoke-PnPSiteDesign is limited to 30 actions and subactions). This command is intended to replace Invoke-PnPSiteDesign and is useful when you need to apply a large number of actions or multiple site scripts.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPSiteDesignTask</command:noun> </command:details> <maml:description> <maml:para>Allows to apply a site design to a specified site collection. This command is intended to be used when you need to apply a large number of actions or multiple site scripts.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteDesignTask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para>The ID of the site design to apply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the site collection where the site design will be applied. If not specified the design will be applied to the site you connected to with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para>The ID of the site design to apply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the site collection where the site design will be applied. If not specified the design will be applied to the site you connected to with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteDesignTask -SiteDesignId 501z8c32-4147-44d4-8607-26c2f67cae82 ```</maml:para> <maml:para>This example applies a site design to the currently connected site. Executing the commands will schedule the site design to be queued and run against the designated site collection.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteDesignTask -SiteDesignId 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/project" ```</maml:para> <maml:para>This example applies a site design to the designated site. Executing the commands will schedule the site design to be queued and run against the designated site collection.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPSiteScript</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Creates a new Site Script on the current tenant</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPSiteScript</command:noun> </command:details> <maml:description> <maml:para>Allows to add a Site Script on the current tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteScript</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Content</maml:name> <maml:description> <maml:para>A JSON string containing the site script. See the [Microsoft Learn site](https://learn.microsoft.com/sharepoint/dev/declarative-customization/site-design-json-schema) for documentation on how to create such a JSON schema.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site script</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Content</maml:name> <maml:description> <maml:para>A JSON string containing the site script. See the [Microsoft Learn site](https://learn.microsoft.com/sharepoint/dev/declarative-customization/site-design-json-schema) for documentation on how to create such a JSON schema.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site script</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteScript -Title "My Site Script" -Description "A more detailed description" -Content $script ```</maml:para> <maml:para>Adds a new Site Script, where $script variable contains the script.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Site template JSON schema documentation</maml:linkText> <command:uri>https://learn.microsoft.com/sharepoint/dev/declarative-customization/site-design-json-schema</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPSiteScriptPackage</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Creates a new Site Script Package on the current tenant. Site script packages can contain files in addition to the site scripts which can be used to upload files to sites on which a site template gets applied.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPSiteScriptPackage</command:noun> </command:details> <maml:description> <maml:para>Allows to add a new Site Script Package on the current tenant</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteScriptPackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ContentPath</maml:name> <maml:description> <maml:para>The full path to the locally stored Site Script Package to upload</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site script package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site script package</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ContentPath</maml:name> <maml:description> <maml:para>The full path to the locally stored Site Script Package to upload</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the site script package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the site script package</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteScriptPackage -Title "My Site Script Package" -Description "A more detailed description" -ContentPath "c:\package.zip" ```</maml:para> <maml:para>Adds a new Site Script Package</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPSiteTemplate</command:name> <maml:description> <maml:para>Adds a PnP Site Template object to a tenant template</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPSiteTemplate</command:noun> </command:details> <maml:description> <maml:para>Allows to add PnP Site Template object to a tenant template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPSiteTemplate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteTemplate</maml:name> <maml:description> <maml:para>The template to add to the tenant template</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteTemplate</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TenantTemplate</maml:name> <maml:description> <maml:para>The tenant template to add the template to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProvisioningHierarchy</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteTemplate</maml:name> <maml:description> <maml:para>The template to add to the tenant template</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteTemplate</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TenantTemplate</maml:name> <maml:description> <maml:para>The tenant template to add the template to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProvisioningHierarchy</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPSiteTemplate -TenantTemplate $tenanttemplate -SiteTemplate $sitetemplate ```</maml:para> <maml:para>Adds an existing site template to an existing tenant template object</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPStoredCredential</command:name> <maml:description> <maml:para>Adds a credential to the Windows Credential Manager or Mac OS Key Chain Entry.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPStoredCredential</command:noun> </command:details> <maml:description> <maml:para>Adds an entry to the Windows Credential Manager or Mac OS Key Chain Entry. 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.</maml:para> <maml:para>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" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The credential to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Use parameter to overwrite existing Mac OS Key Chain Entry. Not required on Windows.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Username</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The credential to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Use parameter to overwrite existing Mac OS Key Chain Entry. Not required on Windows.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Username</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPStoredCredential -Name "https://tenant.sharepoint.com" -Username yourname@tenant.onmicrosoft.com ```</maml:para> <maml:para>You will be prompted to specify the password and a new entry will be added with the specified values</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPStoredCredential -Name "https://tenant.sharepoint.com" -Username yourname@tenant.onmicrosoft.com -Password (ConvertTo-SecureString -String "YourPassword" -AsPlainText -Force) ```</maml:para> <maml:para>A new entry will be added with the specified values</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell 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" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPTaxonomyField</command:name> <maml:description> <maml:para>Add a taxonomy field</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPTaxonomyField</command:noun> </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="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FieldOptions</maml:name> <maml:description> <maml:para>Specifies the control settings while adding a field. See https://learn.microsoft.com/previous-versions/office/sharepoint-server/ee542202(v=office.15) for details</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AddFieldOptions</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>InternalName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPTaxonomyField</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FieldOptions</maml:name> <maml:description> <maml:para>Specifies the control settings while adding a field. See https://learn.microsoft.com/previous-versions/office/sharepoint-server/ee542202(v=office.15) for details</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AddFieldOptions</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>InternalName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TaxonomyItemId</maml:name> <maml:description> <maml:para>The ID of the Taxonomy item</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FieldOptions</maml:name> <maml:description> <maml:para>Specifies the control settings while adding a field. See https://learn.microsoft.com/previous-versions/office/sharepoint-server/ee542202(v=office.15) for details</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AddFieldOptions</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>InternalName</maml:name> <maml:description> <maml:para>The internal name of the field</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TaxonomyItemId</maml:name> <maml:description> <maml:para>The ID of the Taxonomy item</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTaxonomyField -DisplayName "Test" -InternalName "Test" -TermSetPath "TestTermGroup|TestTermSet" ```</maml:para> <maml:para>Adds a new taxonomy field called "Test" that points to the TestTermSet which is located in the TestTermGroup</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTaxonomyField -DisplayName "Test" -InternalName "Test" -TaxonomyItemId "0e5fe3c6-3e6a-4d25-9f48-82a655f15992" ```</maml:para> <maml:para>Adds a new taxonomy field called "Test" that points to the Term set with the term set id of 0e5fe3c6-3e6a-4d25-9f48-82a655f15992</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPTeamsChannel</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Group.ReadWrite.All Adds a channel to an existing Microsoft Teams team.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPTeamsChannel</command:noun> </command:details> <maml:description> <maml:para>Allows to add channel to an existing team in Microsoft Teams. By using the `IsFavoriteByDefault` it is possible to specify if the channel will be visible for members by default.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTeamsChannel</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ChannelType</maml:name> <maml:description> <maml:para>Allows specifying the type of channel to be created. Possible values are Standard, Private, and Shared.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>An optional description of the channel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the new channel. Letters, numbers, and spaces are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsFavoriteByDefault</maml:name> <maml:description> <maml:para>Allows you to specify if the channel is by default visible for members. **This parameter is obsolete. [Microsoft Graph API docs](https://learn.microsoft.com/en-us/graph/api/resources/channel?view=graph-rest-1.0#properties) mention that it only works when you create a channel in Teams creation request. It will be removed in a future version.**</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPTeamsChannel</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ChannelType</maml:name> <maml:description> <maml:para>Allows specifying the type of channel to be created. Possible values are Standard, Private, and Shared.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>An optional description of the channel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the new channel. Letters, numbers, and spaces are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OwnerUPN</maml:name> <maml:description> <maml:para>The User Principal Name (email) of the owner of the channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPTeamsChannel</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ChannelType</maml:name> <maml:description> <maml:para>Allows specifying the type of channel to be created. Possible values are Standard, Private, and Shared.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>An optional description of the channel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the new channel. Letters, numbers, and spaces are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsFavoriteByDefault</maml:name> <maml:description> <maml:para>Allows you to specify if the channel is by default visible for members. **This parameter is obsolete. [Microsoft Graph API docs](https://learn.microsoft.com/en-us/graph/api/resources/channel?view=graph-rest-1.0#properties) mention that it only works when you create a channel in Teams creation request. It will be removed in a future version.**</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OwnerUPN</maml:name> <maml:description> <maml:para>The User Principal Name (email) of the owner of the channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ChannelType</maml:name> <maml:description> <maml:para>Allows specifying the type of channel to be created. Possible values are Standard, Private, and Shared.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>An optional description of the channel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the new channel. Letters, numbers, and spaces are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsFavoriteByDefault</maml:name> <maml:description> <maml:para>Allows you to specify if the channel is by default visible for members. **This parameter is obsolete. [Microsoft Graph API docs](https://learn.microsoft.com/en-us/graph/api/resources/channel?view=graph-rest-1.0#properties) mention that it only works when you create a channel in Teams creation request. It will be removed in a future version.**</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OwnerUPN</maml:name> <maml:description> <maml:para>The User Principal Name (email) of the owner of the channel.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsChannel -Team 4efdf392-8225-4763-9e7f-4edeb7f721aa -DisplayName "My Channel" -IsFavoriteByDefault $true ```</maml:para> <maml:para>Adds a new standard channel to the Team specified by its identifier and marks the channel as by default visible for members.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsChannel -Team "My Team" -DisplayName "My standard channel" ```</maml:para> <maml:para>Adds a new standard channel to the Team specified by its name.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsChannel -Team "HR" -DisplayName "My private channel" -ChannelType Private -OwnerUPN user1@domain.com ```</maml:para> <maml:para>Adds a new private channel to the Team specified by its name and sets the provided user as the owner of the channel.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsChannel -Team "Logistical Department" -DisplayName "My shared channel" -ChannelType Shared -OwnerUPN user1@domain.com ```</maml:para> <maml:para>Adds a new shared channel to the Team specified by its name and sets the provided user as the owner of the channel.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPTeamsChannelUser</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: ChannelMember.ReadWrite.All Adds a user to an existing Microsoft Teams private channel.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPTeamsChannelUser</command:noun> </command:details> <maml:description> <maml:para>Allows to add a user to a private channel in Microsoft Teams.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTeamsChannelUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>The id or name of the channel to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsChannelPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specify the role of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>The id or name of the channel to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsChannelPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specify the role of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>Specify the UPN (e.g. john@doe.com)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsChannelUser -Team 4efdf392-8225-4763-9e7f-4edeb7f721aa -Channel "19:796d063b63e34497aeaf092c8fb9b44e@thread.skype" -User john@doe.com -Role Owner ```</maml:para> <maml:para>Adds user as an owner to the private channel.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsChannelUser -Team "My Team" -Channel "My Private Channel" -User john@doe.com -Role Member ```</maml:para> <maml:para>Adds user as a member to the private channel.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPTeamsTab</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Group.ReadWrite.All Adds a tab to an existing Channel. Note that the `-ContentUrl` is a 'dynamic' parameter and will only be valid for tab types that support it. Also, some `-Type` values are not configurable due to Microsoft Graph API limitations (i.e.: PowerBI).</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPTeamsTab</command:noun> </command:details> <maml:description> <maml:para>Allows to add a tab to an existing Channel. By using `ContentUrl` option you may specify the content of the tab.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTeamsTab</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Specify the channel id or name of the team to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsChannelPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ContentUrl</maml:name> <maml:description> <maml:para>The Url to use to render the content inside the tab within Microsoft Teams.</maml:para> <maml:para>When using Type SharePointPageAndList, the ContentUrl will automatically be generated and cannot be specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specify the tab type</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EntityId</maml:name> <maml:description> <maml:para>Specifies the Identifier for the entity hosted by the tab provider.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RemoveUrl</maml:name> <maml:description> <maml:para>Specifies the URL to be called by Teams client when a Tab is removed using the Teams Client.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify the tab type</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamTabType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebsiteUrl</maml:name> <maml:description> <maml:para>The Url to use when the user clicks on the dropdown of the tab in Microsoft Teams and clicks on "Go to website".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Specify the channel id or name of the team to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsChannelPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ContentUrl</maml:name> <maml:description> <maml:para>The Url to use to render the content inside the tab within Microsoft Teams.</maml:para> <maml:para>When using Type SharePointPageAndList, the ContentUrl will automatically be generated and cannot be specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specify the tab type</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EntityId</maml:name> <maml:description> <maml:para>Specifies the Identifier for the entity hosted by the tab provider.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RemoveUrl</maml:name> <maml:description> <maml:para>Specifies the URL to be called by Teams client when a Tab is removed using the Teams Client.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify the tab type</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamTabType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebsiteUrl</maml:name> <maml:description> <maml:para>The Url to use when the user clicks on the dropdown of the tab in Microsoft Teams and clicks on "Go to website".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsTab -Team "My Team" -Channel "My Channel" -DisplayName "My Tab Name" -Type WebSite -ContentUrl "https://aka.ms/m365pnp" ```</maml:para> <maml:para>Adds a web site tab to the specified channel.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsTab -Team "My Team" -Channel "My Channel" -DisplayName "My Tab Name" -Type PDF -ContentUrl "https://contoso.sharepoint.com/sites/Marketing/Shared Documents/General/MyFile.pdf" -EntityId "null" ```</maml:para> <maml:para>Adds the specified PDF file from the "Documents" library as a tab.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsTab -Team "My Team" -Channel "My Channel" -DisplayName "My Tab Name" -Type SharePointPageAndList -WebSiteUrl "https://contoso.sharepoint.com/sites/Marketing/SitePages/Home.aspx" ```</maml:para> <maml:para>Adds the specified SharePoint page as a tab in Teams. Note that the ContentUrl will automatically be generated and cannot be specified, and the `-WebsiteUrl` parameter is only available from version `2.x` onwards.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsTab -Team "My Team" -Channel "My Channel" -DisplayName "My Excel Tab" -Type Excel -ContentUrl "https://contoso.sharepoint.com/sites/Marketing/Shared Documents/My Excel File.csv" -EntityId 6 ```</maml:para> <maml:para>Adds the "My Excel file.csv" with ID 6 as a tab from the Marketing site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell $PlannerPlan = Get-PnPPlannerPlan -Group $groupId -Identity $PlannerName if(-not $PlannerPlan) { $PlannerPlan = New-PnPPlannerPlan -Group $groupId -Title $PlannerName } $bucket = Add-PnPPlannerBucket -Group $groupId -Plan $PlannerPlan.Id -Name "Tasks" Add-PnPPlannerTask -Group $groupId -Plan $PlannerPlan.Id -Bucket $bucket.Id -Title "plannertaskA"</maml:para> <maml:para>$teamsChannel = Get-PnPTeamsChannel -Team $groupId -Identity "General"</maml:para> <maml:para>$tenant = "contoso.onmicrosoft.com"</maml:para> <maml:para>$teamsTab = Add-PnPTeamsTab -Team $groupId -Channel $teamsChannel -DisplayName "My Tab Name" -Type Planner -ContentUrl "https://tasks.office.com/$tenant/Home/PlannerFrame?page=7&planId=$($PlannerPlan.Id)"</maml:para> <maml:para>```</maml:para> <maml:para>Gets the existing Planner if one exists in the Group, otherwise creates a new. Adds a new bucket and creates a few new Tasks. Finally creates a Tab in the channel named "My Tab Name"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPTeamsTeam</command:name> <maml:description> <maml:para>Adds a Teams team to an existing, group connected, site collection</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPTeamsTeam</command:noun> </command:details> <maml:description> <maml:para>This command allows you to add a Teams team to an existing, Microsoft 365 group connected, site collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTeamsTeam</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsTeam ```</maml:para> <maml:para>This create a teams team for the connected site collection</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPTeamsUser</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Group.ReadWrite.All Adds a user to an existing Microsoft Teams instance.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPTeamsUser</command:noun> </command:details> <maml:description> <maml:para>This cmdlet adds one or more users to an existing Team.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTeamsUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specify the role of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPTeamsUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specify the role of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Specify the channel id or name of the team to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TeamsChannelPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specify the role of the user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>Specify the UPN (e.g. john@doe.com)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Users</maml:name> <maml:description> <maml:para>Specify the users UPN (e.g. john@doe.com, jane@doe.com)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String array</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsUser -Team MyTeam -User john@doe.com -Role Owner ```</maml:para> <maml:para>Adds a user as an owner to the team.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsUser -Team MyTeam -User john@doe.com -Role Member ```</maml:para> <maml:para>Adds a user as a member to the team.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsUser -Team MyTeam -Users "john@doe.com","jane@doe.com" -Role Member ```</maml:para> <maml:para>Adds multiple users as members to the team.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTeamsUser -Team MyTeam -User "jane@doe.com" -Role Member -Channel Private ```</maml:para> <maml:para>Adds user as a member to a private channel named Private in MyTeam team.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPTenantCdnOrigin</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Adds a new origin to the public or private content delivery network (CDN).</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPTenantCdnOrigin</command:noun> </command:details> <maml:description> <maml:para>Add a new origin to the public or private CDN, on either Tenant level or on a single Site level. Effectively, a tenant admin points out to a document library, or a folder in the document library and requests that content in that library should be retrievable by using a CDN.</maml:para> <maml:para>You must be a SharePoint Online Administrator and a site collection administrator to run the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTenantCdnOrigin</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>Specifies the CDN type. The valid values are: public or private.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SPOTenantCdnType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OriginUrl</maml:name> <maml:description> <maml:para>Specifies a path to the doc library to be configured. It can be provided in two ways: relative path, or a mask.</maml:para> <maml:para>Relative path depends on the OriginScope. If the originScope is Tenant, a path must be a relative path under the tenant root. If the originScope is Site, a path must be a relative path under the given Site. The path must point to the valid Document Library or a folder with a document library.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CdnType</maml:name> <maml:description> <maml:para>Specifies the CDN type. The valid values are: public or private.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SPOTenantCdnType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OriginUrl</maml:name> <maml:description> <maml:para>Specifies a path to the doc library to be configured. It can be provided in two ways: relative path, or a mask.</maml:para> <maml:para>Relative path depends on the OriginScope. If the originScope is Tenant, a path must be a relative path under the tenant root. If the originScope is Site, a path must be a relative path under the given Site. The path must point to the valid Document Library or a folder with a document library.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTenantCdnOrigin -OriginUrl /sites/site/subfolder -CdnType Public ```</maml:para> <maml:para>This example configures a public CDN on site level.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPTenantRestrictedSearchAllowedList</command:name> <maml:description> <maml:para>Adds site URLs to the allowed list when Restricted SharePoint Search is enabled. The URLs can be provided as a string array or read from a CSV file.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPTenantRestrictedSearchAllowedList</command:noun> </command:details> <maml:description> <maml:para>Adds site URLs to the allowed list when Restricted SharePoint Search is enabled. The URLs can be provided directly as a string array or read from a CSV file. At present, a maximum of 100 sites can be added to the allowed list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTenantRestrictedSearchAllowedList</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Containsheader</maml:name> <maml:description> <maml:para>If specified, this switch skips the first line from the CSV file, which is assumed to be a header.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParamter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SitesList</maml:name> <maml:description> <maml:para>Specifies a collection of sites to add to the allowed list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SitesListFileUrl</maml:name> <maml:description> <maml:para>Specifies the path of the CSV file that contains a list of site URLs to be added to the allowed list when the tenant is set to Restricted Tenant Search Mode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTenantRestrictedSearchAllowedList -SitesListFileUrl "C:\temp\sitelist.csv" -ContainsHeader ```</maml:para> <maml:para>Adds site URLs to the allowed list from a CSV file. The first line, which is assumed to be a header, is skipped.</maml:para> <maml:para>Sample CSV file content with Header</maml:para> <maml:para>SiteUrl https://contoso.sharepoint.com/sites/Company311 https://contoso.sharepoint.com/sites/contosoportal</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTenantRestrictedSearchAllowedList -SitesListFileUrl "C:\temp\sitelist.csv" ```</maml:para> <maml:para>Adds site URLs to the allowed list from a CSV file.</maml:para> <maml:para>Sample CSV file content without Header</maml:para> <maml:para>https://contoso.sharepoint.com/sites/Company311 https://contoso.sharepoint.com/sites/contosoportal</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTenantRestrictedSearchAllowedList -SitesList @("https://contoso.sharepoint.com/sites/Company311","https://contoso.sharepoint.com/sites/contosoportal") ```</maml:para> <maml:para>Adds the specified sites to the allowed list.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>How does Restricted SharePoint Search work?</maml:linkText> <command:uri>https://learn.microsoft.com/sharepoint/restricted-sharepoint-search</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPTenantSequence</command:name> <maml:description> <maml:para>Adds a tenant sequence object to a tenant template</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPTenantSequence</command:noun> </command:details> <maml:description> <maml:para>Allows to add a tenant sequence object to a tenant template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTenantSequence</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Optional Id of the sequence</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProvisioningSequence</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Template</maml:name> <maml:description> <maml:para>The template to add the sequence to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProvisioningHierarchy</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>Optional Id of the sequence</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProvisioningSequence</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Template</maml:name> <maml:description> <maml:para>The template to add the sequence to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProvisioningHierarchy</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTenantSequence -Template $mytemplate -Sequence $mysequence ```</maml:para> <maml:para>Adds an existing sequence object to an existing template object</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell New-PnPTenantSequence -Id "MySequence" | Add-PnPTenantSequence -Template $template ```</maml:para> <maml:para>Creates a new instance of a provisioning sequence object and sets the Id to the value specified, then the sequence is added to an existing template object</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPTenantSequenceSite</command:name> <maml:description> <maml:para>Adds an existing tenant sequence site object to a tenant template</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPTenantSequenceSite</command:noun> </command:details> <maml:description> <maml:para>Allows to add an existing tenant sequence site object to a tenant template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTenantSequenceSite</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>The sequence to add the site to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProvisioningSequence</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">ProvisioningSitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Sequence</maml:name> <maml:description> <maml:para>The sequence to add the site to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ProvisioningSequence</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">ProvisioningSitePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTenantSequenceSite -Site $myteamsite -Sequence $mysequence ```</maml:para> <maml:para>Adds an existing site object to an existing template sequence</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPTenantSequenceSubSite</command:name> <maml:description> <maml:para>Adds a tenant sequence sub site object to a tenant sequence site object</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPTenantSequenceSubSite</command:noun> </command:details> <maml:description> <maml:para>Allows to add a tenant sequence sub site object to a tenant sequence site object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTenantSequenceSubSite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to add the subsite to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteCollection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SubSite</maml:name> <maml:description> <maml:para>The subsite to add</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamNoGroupSubSite</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>The site to add the subsite to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SiteCollection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SubSite</maml:name> <maml:description> <maml:para>The subsite to add</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamNoGroupSubSite</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTenantSequenceSubSite -Site $mysite -SubSite $mysubsite ```</maml:para> <maml:para>Adds an existing subsite object to an existing sequence site object</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPTenantTheme</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Adds or updates a theme to the tenant.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPTenantTheme</command:noun> </command:details> <maml:description> <maml:para>Adds or updates a theme to the tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTenantTheme</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the theme to add or update</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ThemePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsInverted</maml:name> <maml:description> <maml:para>If the theme is inverted or not</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Use this parameter to allow existing theme with the same name to be overwritten.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Palette</maml:name> <maml:description> <maml:para>The palette to add. See examples for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ThemePalettePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the theme to add or update</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ThemePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsInverted</maml:name> <maml:description> <maml:para>If the theme is inverted or not</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Use this parameter to allow existing theme with the same name to be overwritten.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Palette</maml:name> <maml:description> <maml:para>The palette to add. See examples for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ThemePalettePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell $themepalette = @{ "themePrimary" = "#00ffff"; "themeLighterAlt" = "#f3fcfc"; "themeLighter" = "#daffff"; "themeLight" = "#affefe"; "themeTertiary" = "#76ffff"; "themeSecondary" = "#39ffff"; "themeDarkAlt" = "#00c4c4"; "themeDark" = "#009090"; "themeDarker" = "#005252"; "neutralLighterAlt" = "#f8f8f8"; "neutralLighter" = "#f4f4f4"; "neutralLight" = "#eaeaea"; "neutralQuaternaryAlt" = "#dadada"; "neutralQuaternary" = "#d0d0d0"; "neutralTertiaryAlt" = "#c8c8c8"; "neutralTertiary" = "#a6a6a6"; "neutralSecondaryAlt" = "#767676"; "neutralSecondary" = "#666666"; "neutralPrimary" = "#333"; "neutralPrimaryAlt" = "#3c3c3c"; "neutralDark" = "#212121"; "black" = "#000000"; "white" = "#fff"; "primaryBackground" = "#fff"; "primaryText" = "#333" } Add-PnPTenantTheme -Identity "MyCompanyTheme" -Palette $themepalette -IsInverted $false ```</maml:para> <maml:para>This example adds a theme to the current tenant.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell $themepalette = @{ "themePrimary" = "#00ffff"; "themeLighterAlt" = "#f3fcfc"; "themeLighter" = "#daffff"; "themeLight" = "#affefe"; "themeTertiary" = "#76ffff"; "themeSecondary" = "#39ffff"; "themeDarkAlt" = "#00c4c4"; "themeDark" = "#009090"; "themeDarker" = "#005252"; "neutralLighterAlt" = "#f8f8f8"; "neutralLighter" = "#f4f4f4"; "neutralLight" = "#eaeaea"; "neutralQuaternaryAlt" = "#dadada"; "neutralQuaternary" = "#d0d0d0"; "neutralTertiaryAlt" = "#c8c8c8"; "neutralTertiary" = "#a6a6a6"; "neutralSecondaryAlt" = "#767676"; "neutralSecondary" = "#666666"; "neutralPrimary" = "#333"; "neutralPrimaryAlt" = "#3c3c3c"; "neutralDark" = "#212121"; "black" = "#000000"; "white" = "#fff"; "primaryBackground" = "#fff"; "primaryText" = "#333" } Add-PnPTenantTheme -Identity "MyCompanyTheme" -Palette $themepalette -IsInverted $false -Overwrite ```</maml:para> <maml:para>This example overwrites an existing theme on the current tenant.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPTermToTerm</command:name> <maml:description> <maml:para>Adds a new term to an existing term.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPTermToTerm</command:noun> </command:details> <maml:description> <maml:para>This cmdlet adds a new taxonomy term as a child term to an existing term.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPTermToTerm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CustomProperties</maml:name> <maml:description> <maml:para>Custom Properties</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LocalCustomProperties</maml:name> <maml:description> <maml:para>Custom Properties</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the term.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ParentTermId</maml:name> <maml:description> <maml:para>The Id of the parent term.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CustomProperties</maml:name> <maml:description> <maml:para>Custom Properties</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LocalCustomProperties</maml:name> <maml:description> <maml:para>Custom Properties</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the term.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ParentTermId</maml:name> <maml:description> <maml:para>The Id of the parent term.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPTermToTerm -ParentTermId 2d1f298b-804a-4a05-96dc-29b667adec62 -Name SubTerm -CustomProperties @{"Department"="Marketing"} ```</maml:para> <maml:para>Creates a new taxonomy child term named "SubTerm" in the specified term by id 2d1f298b-804a-4a05-96dc-29b667adec62.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell $parentTerm = Get-PnPTerm -Name Marketing -TermSet Departments -TermGroup Corporate Add-PnPTermToTerm -ParentTermId $parentTerm.Id -Name "Conference Team" ```</maml:para> <maml:para>Creates a new taxonomy child term named "Conference Team" in the specified term called Marketing which is located in the Departments term set.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPView</command:name> <maml:description> <maml:para>Adds a view to a list</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPView</command:noun> </command:details> <maml:description> <maml:para>Allows to add a new view to a list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPView</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Aggregations</maml:name> <maml:description> <maml:para>A valid XML fragment containing one or more Aggregations</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A list of fields to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Paged</maml:name> <maml:description> <maml:para>If specified, the view will have paging.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Query</maml:name> <maml:description> <maml:para>A valid CAML Query.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ViewType</maml:name> <maml:description> <maml:para>The type of view to add.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ViewType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Aggregations</maml:name> <maml:description> <maml:para>A valid XML fragment containing one or more Aggregations</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A list of fields to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Paged</maml:name> <maml:description> <maml:para>If specified, the view will have paging.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Query</maml:name> <maml:description> <maml:para>A valid CAML Query.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the view.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ViewType</maml:name> <maml:description> <maml:para>The type of view to add.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ViewType</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPView -List "Demo List" -Title "Demo View" -Fields "Title","Address" ```</maml:para> <maml:para>Adds a view named "Demo view" to the "Demo List" list.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPView -List "Demo List" -Title "Demo View" -Fields "Title","Address" -Paged -RowLimit 100 ```</maml:para> <maml:para>Adds a view named "Demo view" to the "Demo List" list and makes sure there's paging on this view, setting a RowLimit different than the default (30 items).</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPView -List "Demo List" -Title "Demo View" -Fields "Title","Address" -Aggregations "<FieldRef Name='Title' Type='COUNT'/>" ```</maml:para> <maml:para>Adds a view named "Demo view" to the "Demo List" list and sets the totals (aggregations) to Count on the Title field.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPViewsFromXML</command:name> <maml:description> <maml:para>Adds one or more views to a list from an XML string.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPViewsFromXML</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows the creation of one or more views on a SharePoint Online list based on passing in an XML definition with the view details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPViewsFromXML</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list to add the view to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ViewsXML</maml:name> <maml:description> <maml:para>The XML string of the view(s) that you want to add to the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list to add the view to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ViewsXML</maml:name> <maml:description> <maml:para>The XML string of the view(s) that you want to add to the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell</maml:para> <maml:para>$viewsXML = @" <ListViews> <List Type='GenericList'> <View Name='Demo View' ViewTypeKind='Html' OrderedView='TRUE' ViewFields='Author,Created,Editor,Modified' RowLimit='30' DefaultView='TRUE'> <ViewQuery> <OrderBy> <FieldRef Name='ID' Ascending='FALSE'/> </OrderBy> </ViewQuery> </View> </List> </ListViews> "@</maml:para> <maml:para>Add-PnPViewsFromXML -List "Demo List" -ViewsXML $viewsXML ```</maml:para> <maml:para>Adds one view named "Demo view" to the "Demo List" list from the XML string.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell</maml:para> <maml:para>$viewsXML = @" <ListViews> <List Type='GenericList'> <View Name='Demo View' ViewTypeKind='Html' OrderedView='TRUE' ViewFields='Author,Created,Editor,Modified' RowLimit='30' DefaultView='TRUE'> <ViewQuery> <OrderBy> <FieldRef Name='ID' Ascending='FALSE'/> </OrderBy> </ViewQuery> </View> </List> <List Type='GenericList'> <View Name='Created By Me' ViewTypeKind='Html' OrderedView='TRUE' ViewFields='Author,Created,Editor,Modified' RowLimit='30' DefaultView='FALSE'> <ViewQuery> <Where> <Eq> <FieldRef Name='Author' /> <Value Type='Integer'> <UserID Type='Integer' /> </Value> </Eq> </Where> <OrderBy> <FieldRef Name='Created' Ascending='FALSE'/> </OrderBy> </ViewQuery> </View> </List> </ListViews> "@</maml:para> <maml:para>Add-PnPViewsFromXML -List "Demo List" -ViewsXML $viewsXML ```</maml:para> <maml:para>Adds two views named "Demo view" and "Created By Me" to the "Demo List" list from the XML string.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPVivaConnectionsDashboardACE</command:name> <maml:description> <maml:para>Add an Adaptive card extension in the Viva connections dashboard page. This requires that you connect to a SharePoint Home site and have configured the Viva connections page.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPVivaConnectionsDashboardACE</command:noun> </command:details> <maml:description> <maml:para>Allows to add a new an Adaptive card extension in the Viva Home dashboard page. Before running the command it is required you are connect to a SharePoint Home site and have configured the Viva connections page.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPVivaConnectionsDashboardACE</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CardSize</maml:name> <maml:description> <maml:para>The size of the Adaptive Card extension. The available values are `Large` or `Medium`. Default card size is `Medium`</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CardSize</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description of the Adaptive Card extension.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IconProperty</maml:name> <maml:description> <maml:para>The Icon used by Adaptive Card extension.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id of the Adaptive Card on the Viva connections dashboard page. Supported values are:</maml:para> <maml:para>- Approvals - AssignedTasks - CardDesigner - Shifts - TeamsApp - ThirdParty - WebLink</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DefaultACE</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>The Order of appearance of the Adaptive Card extension on the Viva connections dashboard page. The default value is 0.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PropertiesJSON</maml:name> <maml:description> <maml:para>The properties of the Adaptive Card extension. You can get the properties by executing `Get-PnPVivaConnectionsDashboardACE` and then use the `JSONProperties`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The Title of the Adaptive Card extension.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CardSize</maml:name> <maml:description> <maml:para>The size of the Adaptive Card extension. The available values are `Large` or `Medium`. Default card size is `Medium`</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CardSize</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description of the Adaptive Card extension.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IconProperty</maml:name> <maml:description> <maml:para>The Icon used by Adaptive Card extension.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id of the Adaptive Card on the Viva connections dashboard page. Supported values are:</maml:para> <maml:para>- Approvals - AssignedTasks - CardDesigner - Shifts - TeamsApp - ThirdParty - WebLink</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DefaultACE</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Order</maml:name> <maml:description> <maml:para>The Order of appearance of the Adaptive Card extension on the Viva connections dashboard page. The default value is 0.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PropertiesJSON</maml:name> <maml:description> <maml:para>The properties of the Adaptive Card extension. You can get the properties by executing `Get-PnPVivaConnectionsDashboardACE` and then use the `JSONProperties`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The Title of the Adaptive Card extension.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPVivaConnectionsDashboardACE -Identity CardDesigner -Order 3 -Title "Hello there" -PropertiesJSON $myProperties -CardSize Large -Description "ACE description" -Iconproperty "https://cdn.hubblecontent.osi.office.net/m365content/publish/002f8bf9-b8ee-4689-ae97-e411b756099d/691108002.jpg" ```</maml:para> <maml:para>Add an Adaptive card extension of type Card Designer in the Viva connections dashboard page with Title, Description, IconProperty, Order , CardSize and PropertiesJSON of the ACE.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPVivaConnectionsDashboardACE -Identity ThirdPartyApp -Order 1 -Title "Hello there" -PropertiesJSON $myProperties -CardSize Medium -Description "ACE with description" -Iconproperty "https://cdn.hubblecontent.osi.office.net/m365content/publish/002f8bf9-b8ee-4689-ae97-e411b756099d/691108002.jpg" ```</maml:para> <maml:para>Add an Adaptive card extension of type Third party(custom adaptive card) in the Viva connections dashboard page with Title, Description, IconProperty, Order , CardSize and PropertiesJSON of the ACE.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPVivaConnectionsDashboardACE -Identity AssignedTasks -Order 2 -Title "Tasks" -PropertiesJSON $myProperties -CardSize Medium -Description "My Assigned tasks" -Iconproperty "https://cdn.hubblecontent.osi.office.net/m365content/publish/002f8bf9-b8ee-4689-ae97-e411b756099d/691108002.jpg" ```</maml:para> <maml:para>Add an Adaptive card extension of type AssignedTasks in the Viva connections dashboard page with Title, Description, IconProperty, Order , CardSize and PropertiesJSON of the ACE.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPWebhookSubscription</command:name> <maml:description> <maml:para>Adds a new Webhook subscription</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPWebhookSubscription</command:noun> </command:details> <maml:description> <maml:para>Allows to add a new Webhook subscription to a list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPWebhookSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientState</maml:name> <maml:description> <maml:para>A client state information that will be passed through notifications</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpirationDate</maml:name> <maml:description> <maml:para>The date at which the Webhook subscription will expire. (Default: 6 months from today)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where the Webhook subscription will be added to</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>NotificationUrl</maml:name> <maml:description> <maml:para>The URL of the Webhook endpoint that will be notified of the change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientState</maml:name> <maml:description> <maml:para>A client state information that will be passed through notifications</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpirationDate</maml:name> <maml:description> <maml:para>The date at which the Webhook subscription will expire. (Default: 6 months from today)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The list object or name where the Webhook subscription will be added to</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>NotificationUrl</maml:name> <maml:description> <maml:para>The URL of the Webhook endpoint that will be notified of the change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook ```</maml:para> <maml:para>Add a Webhook subscription for the specified notification Url on the list MyList</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook -ExpirationDate "2017-09-01" ```</maml:para> <maml:para>Add a Webhook subscription for the specified notification Url on the list MyList with an expiration date set on September 1st, 2017</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPWebhookSubscription -List MyList -NotificationUrl https://my-func.azurewebsites.net/webhook -ExpirationDate "2017-09-01" -ClientState "Hello State!" ```</maml:para> <maml:para>Add a Webhook subscription for the specified notification Url on the list MyList with an expiration date set on September 1st, 2017 with a specific client state</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Add</command:verb> <command:noun>PnPWebPartToWebPartPage</command:noun> </command:details> <maml:description> <maml:para>Allows to add a web part to a web part page. Use the `ZoneIndex` option to specify the zone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPWebPartToWebPartPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPWebPartToWebPartPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Path "c:\myfiles\listview.webpart" -ZoneId "Header" -ZoneIndex 1 ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -XML $webpart -ZoneId "Header" -ZoneIndex 1 ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Add</command:verb> <command:noun>PnPWebPartToWikiPage</command:noun> </command:details> <maml:description> <maml:para>Allows to add a web part a wiki page. Use the `Row` and `Column` option to specify the location of the web part.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPWebPartToWikiPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AddSpace</maml:name> <maml:description> <maml:para>Must there be an extra space between the web part</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPWebPartToWikiPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AddSpace</maml:name> <maml:description> <maml:para>Must there be an extra space between the web part</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AddSpace</maml:name> <maml:description> <maml:para>Must there be an extra space between the web part</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPWebPartToWikiPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Path "c:\myfiles\listview.webpart" -Row 1 -Column 1 ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPWebPartToWikiPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -XML $webpart -Row 1 -Column 1 ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Add-PnPWikiPage</command:name> <maml:description> <maml:para>Adds a wiki page</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>PnPWikiPage</command:noun> </command:details> <maml:description> <maml:para>Allows to add a wiki page.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PnPWikiPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Content</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>The server relative page URL</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PnPWikiPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Layout</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">WikiPageLayout</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>The server relative page URL</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Content</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Layout</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">WikiPageLayout</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ServerRelativePageUrl</maml:name> <maml:description> <maml:para>The server relative page URL</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Add-PnPWikiPage -PageUrl '/sites/demo1/pages/wikipage.aspx' -Content 'New WikiPage' ```</maml:para> <maml:para>Creates a new wiki page '/sites/demo1/pages/wikipage.aspx' and sets the content to 'New WikiPage'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Approve-PnPTenantServicePrincipalPermissionRequest</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Approves a permission request for the current tenant's "SharePoint Online Client" service principal</maml:para> </maml:description> <command:verb>Approve</command:verb> <command:noun>PnPTenantServicePrincipalPermissionRequest</command:noun> </command:details> <maml:description> <maml:para>Approves a permission request for the current tenant's "SharePoint Online Client" service principal</maml:para> <maml:para>The return value of a successful call is a permission grant object.</maml:para> <maml:para>To get the collection of permission grants for the "SharePoint Online Client" service principal, use the Get-PnPTenantServicePrincipalPermissionGrants command.</maml:para> <maml:para>Approving a permission request also removes that request from the list of permission requests.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Approve-PnPTenantServicePrincipalPermissionRequest</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RequestId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RequestId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Clear-PnPAzureADGroupMember</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Directory.ReadWrite.All, Group.ReadWrite.All, GroupMember.ReadWrite.All Removes all current members from a particular Azure Active Directory group. This can be a security, distribution or Microsoft 365 group.</maml:para> </maml:description> <command:verb>Clear</command:verb> <command:noun>PnPAzureADGroupMember</command:noun> </command:details> <maml:description> <maml:para>Allows to remove all current members from specified Azure Active Directory group. This can be a security, distribution or Microsoft 365 group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPAzureADGroupMember</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Azure Active Directory group to remove all members from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Azure Active Directory group to remove all members from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPAzureADGroupMember -Identity "Project Team" ```</maml:para> <maml:para>Removes all the current members from the Azure Active Directory group named "Project Team".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/group-delete-members</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Clear-PnPAzureADGroupOwner</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Directory.ReadWrite.All, Group.ReadWrite.All Removes all current owners from a particular Azure Active Directory group. This can be a security, distribution or Microsoft 365 group.</maml:para> </maml:description> <command:verb>Clear</command:verb> <command:noun>PnPAzureADGroupOwner</command:noun> </command:details> <maml:description> <maml:para>Allows to remove all current owners from specified Azure Active Directory group. This can be a security, distribution or Microsoft 365 group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPAzureADGroupOwner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Azure Active Directory group to remove all owners from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Azure Active Directory group to remove all owners from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPAzureADGroupOwner -Identity "Project Team" ```</maml:para> <maml:para>Removes all the current owners from the Azure Active Directory group named "Project Team".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/group-delete-owners</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Clear-PnPDefaultColumnValues</command:name> <maml:description> <maml:para>Clear default column values for a document library</maml:para> </maml:description> <command:verb>Clear</command:verb> <command:noun>PnPDefaultColumnValues</command:noun> </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="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPDefaultColumnValues -List Documents -Field MyField ```</maml:para> <maml:para>Clears the default value for the field MyField on a library</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPDefaultColumnValues -List Documents -Field MyField -Folder A ```</maml:para> <maml:para>Clears the default value for the field MyField on the folder A on a library</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Clear-PnPListItemAsRecord</command:name> <maml:description> <maml:para>Un declares a list item as a record</maml:para> </maml:description> <command:verb>Clear</command:verb> <command:noun>PnPListItemAsRecord</command:noun> </command:details> <maml:description> <maml:para>Allows to un declares a list item in a list as a record.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPListItemAsRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPListItemAsRecord -List "Documents" -Identity 4 ```</maml:para> <maml:para>Un declares the document in the documents library with id 4 as a record</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Clear-PnPMicrosoft365GroupMember</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Directory.ReadWrite.All, Group.ReadWrite.All, GroupMember.ReadWrite.All Removes all current members from a particular Microsoft 365 Group</maml:para> </maml:description> <command:verb>Clear</command:verb> <command:noun>PnPMicrosoft365GroupMember</command:noun> </command:details> <maml:description> <maml:para>Allows to remove all current members from a specified Microsoft 365 Group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPMicrosoft365GroupMember</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group to remove all members from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group to remove all members from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPMicrosoft365GroupMember -Identity "Project Team" ```</maml:para> <maml:para>Removes all the current members from the Microsoft 365 Group named "Project Team"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/group-delete-members</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Clear-PnPMicrosoft365GroupOwner</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Directory.ReadWrite.All, Group.ReadWrite.All Removes all current owners from a particular Microsoft 365 Group (aka Unified Group)</maml:para> </maml:description> <command:verb>Clear</command:verb> <command:noun>PnPMicrosoft365GroupOwner</command:noun> </command:details> <maml:description> <maml:para>Allows to remove all current owners from a specified Microsoft 365 Group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPMicrosoft365GroupOwner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group to remove all owners from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group to remove all owners from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPMicrosoft365GroupOwner -Identity "Project Team" ```</maml:para> <maml:para>Removes all the current owners from the Microsoft 365 Group named "Project Team"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/group-delete-owners</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Clear</command:verb> <command:noun>PnPRecycleBinItem</command:noun> </command:details> <maml:description> <maml:para>Allows to permanently delete items from recycle bin. By default the command will delete all items but it is allowed to specify the items by using the `Identity` or `RowLimit` options.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPRecycleBinItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Clears all items</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to clear the recycle bin</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>Limits deletion to specified number of items</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SecondStageOnly</maml:name> <maml:description> <maml:para>If provided, only all the items in the second stage recycle bin will be cleared</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Clear-PnPRecycleBinItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to clear the recycle bin</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">RecycleBinItemPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Clears all items</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to clear the recycle bin</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">RecycleBinItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>Limits deletion to specified number of items</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SecondStageOnly</maml:name> <maml:description> <maml:para>If provided, only all the items in the second stage recycle bin will be cleared</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPRecycleBinItem | Where-Object LeafName -like "*.docx" | Clear-PnPRecycleBinItem ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPRecycleBinItem -Identity 72e4d749-d750-4989-b727-523d6726e442 ```</maml:para> <maml:para>Permanently deletes the recycle bin item with Id 72e4d749-d750-4989-b727-523d6726e442 from the recycle bin</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPRecycleBinItem -Identity $item -Force ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPRecycleBinItem -All -RowLimit 10000 ```</maml:para> <maml:para>Permanently deletes up to 10,000 items in the recycle bin</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Clear-PnPTenantAppCatalogUrl</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Removes the url of the tenant scoped app catalog. It will not delete the site collection itself.</maml:para> </maml:description> <command:verb>Clear</command:verb> <command:noun>PnPTenantAppCatalogUrl</command:noun> </command:details> <maml:description> <maml:para>Allows to remove the url of the tenant scoped app catalog. The app catalog site collection will not be removed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPTenantAppCatalogUrl</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPTenantAppCatalogUrl ```</maml:para> <maml:para>Removes the url of the tenant scoped app catalog</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Clear-PnPTenantRecycleBinItem</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Permanently deletes a site collection from the tenant scoped recycle bin</maml:para> </maml:description> <command:verb>Clear</command:verb> <command:noun>PnPTenantRecycleBinItem</command:noun> </command:details> <maml:description> <maml:para>The Clear-PnPTenantRecycleBinItem cmdlet allows a site collection that has been deleted and still exists in the tenant recycle bin to be permanently deleted from the recycle bin as well.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPTenantRecycleBinItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to permanently delete the site collection from the tenant recycle bin</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the site collection to permanently delete from the tenant recycle bin</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If provided, the PowerShell execution will halt until the operation has completed</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>If provided, no confirmation will be asked to permanently delete the site collection from the tenant recycle bin</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Url of the site collection to permanently delete from the tenant recycle bin</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If provided, the PowerShell execution will halt until the operation has completed</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPTenantRecycleBinItem -Url "https://tenant.sharepoint.com/sites/contoso" ```</maml:para> <maml:para>This will permanently delete site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the tenant recycle bin</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPTenantRecycleBinItem -Url "https://tenant.sharepoint.com/sites/contoso" -Wait ```</maml:para> <maml:para>This will permanently delete site collection with the url 'https://tenant.sharepoint.com/sites/contoso' from the tenant recycle bin and will wait with executing further PowerShell commands until the operation has completed</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Clear-PnPTraceLog</command:name> <maml:description> <maml:para>Clears the log stream in memory</maml:para> </maml:description> <command:verb>Clear</command:verb> <command:noun>PnPTraceLog</command:noun> </command:details> <maml:description> <maml:para>This clears the in memory stored log stream which was started with the [Start-PnPTraceLog -WriteToLogstream](Start-PnPTraceLog.md) cmdlet. It will not clear the log file if one was specified.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-PnPTraceLog</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Clear-PnPTraceLog ```</maml:para> <maml:para>This clears the in memory stored log stream</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Connect-PnPOnline</command:name> <maml:description> <maml:para>Connect to a SharePoint site</maml:para> </maml:description> <command:verb>Connect</command:verb> <command:noun>PnPOnline</command:noun> </command:details> <maml:description> <maml:para>Connects to a SharePoint site or another API and creates a context that is required for the other PnP Cmdlets. See https://pnp.github.io/powershell/articles/connecting.html for more information on the options to connect.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ForceAuthentication</maml:name> <maml:description> <maml:para>Will clear the stored authentication information when using Interactive login (all platforms) and allows you to authenticate again towards a site with different credentials.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Connects to the Entra ID (Azure AD) using interactive login, allowing you to authenticate using multi-factor authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets. It will not touch the current connection which can be established by omitting this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection or subsite to connect to, i.e. tenant.sharepoint.com, https://tenant.sharepoint.com, tenant.sharepoint.com/sites/hr, etc.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>ValidateConnection</maml:name> <maml:description> <maml:para>When provided, the cmdlet will check to ensure the SharePoint Online site specified through `-Url` exists and if not, will throw an exception. If you omit this flag or set it to $false, it will blindly set up a connection without validating that the site actually exists. Making use of this option does make one extra call on the connection attempt, so it is recommended to only use it in scenarios where you know the site you're trying to connect o may not exist and would like to have feedback on this during the connect.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureADLoginEndPoint</maml:name> <maml:description> <maml:para>Custom Azure AD login endpoint to be used if we are using Azure Custom environment to retrieve access token. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The Client ID of the Azure AD Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be reused by the new connection. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> <maml:para>When passed in, the ClientId/AppId used for the passed in connection will be used for the new connection. It will override any -ClientId or -AppId parameter passed in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Credentials of the user to connect with. Either specify a PSCredential object or a string. In case of a string value a lookup will be done to the Generic Credentials section of the Windows Credentials in the Windows Credential Manager for the correct credentials.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CredentialPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CurrentCredentials</maml:name> <maml:description> <maml:para>Use credentials of the currently logged in user. Applicable exclusively when connecting to on premises SharePoint Server via PnP. Switch parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CredentialPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>MicrosoftGraphEndPoint</maml:name> <maml:description> <maml:para>Custom Microsoft Graph endpoint to be used if we are using Azure Custom environment. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PersistLogin</maml:name> <maml:description> <maml:para>Persist the current access token and related information in a locally stored cache. This cache will be retained between PowerShell sessions and will also be available after a reboot. You only need to provide this switch one time on Connect-PnPOnline cmdlet, it will after that retain the information and reuse it for new connections to the same tenant. Notice that while using a cached token, if you change the permissions of an application registration, the token associated with that registration will not be updated automatically in the cache. You will have to clear the cache entry first and reauthenticate: use `Disconnect-PnPOnline -ClearPersistedLogin`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RedirectUri</maml:name> <maml:description> <maml:para>The Redirect URI of the Azure AD Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets. It will not touch the current connection which can be established by omitting this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TransformationOnPrem</maml:name> <maml:description> <maml:para>If you want to the use page transformation cmdlets, setting this switch will allow you to connect to an on-prem server. Notice that this -only- applies to Transformation cmdlets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection or subsite to connect to, i.e. tenant.sharepoint.com, https://tenant.sharepoint.com, tenant.sharepoint.com/sites/hr, etc.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>ValidateConnection</maml:name> <maml:description> <maml:para>When provided, the cmdlet will check to ensure the SharePoint Online site specified through `-Url` exists and if not, will throw an exception. If you omit this flag or set it to $false, it will blindly set up a connection without validating that the site actually exists. Making use of this option does make one extra call on the connection attempt, so it is recommended to only use it in scenarios where you know the site you're trying to connect o may not exist and would like to have feedback on this during the connect.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureADLoginEndPoint</maml:name> <maml:description> <maml:para>Custom Azure AD login endpoint to be used if we are using Azure Custom environment to retrieve access token. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>The client secret to use. When using this, technically an Azure Access Control Service (ACS) authentication will take place. This effectively means only cmdlets that are connecting to SharePoint Online will work. Cmdlets using Microsoft Graph or any other API behind the scenes will not work.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be reused by the new connection. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> <maml:para>When passed in, the ClientId/AppId used for the passed in connection will be used for the new connection. It will override any -ClientId or -AppId parameter passed in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>MicrosoftGraphEndPoint</maml:name> <maml:description> <maml:para>Custom Microsoft Graph endpoint to be used if we are using Azure Custom environment. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets. It will not touch the current connection which can be established by omitting this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection or subsite to connect to, i.e. tenant.sharepoint.com, https://tenant.sharepoint.com, tenant.sharepoint.com/sites/hr, etc.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>ValidateConnection</maml:name> <maml:description> <maml:para>When provided, the cmdlet will check to ensure the SharePoint Online site specified through `-Url` exists and if not, will throw an exception. If you omit this flag or set it to $false, it will blindly set up a connection without validating that the site actually exists. Making use of this option does make one extra call on the connection attempt, so it is recommended to only use it in scenarios where you know the site you're trying to connect o may not exist and would like to have feedback on this during the connect.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureADLoginEndPoint</maml:name> <maml:description> <maml:para>Custom Azure AD login endpoint to be used if we are using Azure Custom environment to retrieve access token. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CertificateBase64Encoded</maml:name> <maml:description> <maml:para>Specify a base64 encoded string as representing the private certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CertificatePassword</maml:name> <maml:description> <maml:para>Password to the certificate (*.pfx)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CertificatePath</maml:name> <maml:description> <maml:para>Path to the certificate containing the private key (*.pfx)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be reused by the new connection. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> <maml:para>When passed in, the ClientId/AppId used for the passed in connection will be used for the new connection. It will override any -ClientId or -AppId parameter passed in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>MicrosoftGraphEndPoint</maml:name> <maml:description> <maml:para>Custom Microsoft Graph endpoint to be used if we are using Azure Custom environment. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets. It will not touch the current connection which can be established by omitting this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>The Azure Active Directory tenant name, e.g. mycompany.onmicrosoft.com or mycompany.com if you have added custom domains to your tenant</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection or subsite to connect to, i.e. tenant.sharepoint.com, https://tenant.sharepoint.com, tenant.sharepoint.com/sites/hr, etc.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>ValidateConnection</maml:name> <maml:description> <maml:para>When provided, the cmdlet will check to ensure the SharePoint Online site specified through `-Url` exists and if not, will throw an exception. If you omit this flag or set it to $false, it will blindly set up a connection without validating that the site actually exists. Making use of this option does make one extra call on the connection attempt, so it is recommended to only use it in scenarios where you know the site you're trying to connect o may not exist and would like to have feedback on this during the connect.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>X509KeyStorageFlags</maml:name> <maml:description> <maml:para>Defines where and how to import the private key of an X.509 certificate.</maml:para> <maml:para>This enumeration supports a bitwise combination of its member values.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Security.Cryptography.X509Certificates.X509KeyStorageFlags</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureADLoginEndPoint</maml:name> <maml:description> <maml:para>Custom Azure AD login endpoint to be used if we are using Azure Custom environment to retrieve access token. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be reused by the new connection. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> <maml:para>When passed in, the ClientId/AppId used for the passed in connection will be used for the new connection. It will override any -ClientId or -AppId parameter passed in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>MicrosoftGraphEndPoint</maml:name> <maml:description> <maml:para>Custom Microsoft Graph endpoint to be used if we are using Azure Custom environment. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets. It will not touch the current connection which can be established by omitting this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>The Azure Active Directory tenant name, e.g. mycompany.onmicrosoft.com or mycompany.com if you have added custom domains to your tenant</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>The thumbprint of the certificate containing the private key registered with the application in Azure Active Directory</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection or subsite to connect to, i.e. tenant.sharepoint.com, https://tenant.sharepoint.com, tenant.sharepoint.com/sites/hr, etc.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>ValidateConnection</maml:name> <maml:description> <maml:para>When provided, the cmdlet will check to ensure the SharePoint Online site specified through `-Url` exists and if not, will throw an exception. If you omit this flag or set it to $false, it will blindly set up a connection without validating that the site actually exists. Making use of this option does make one extra call on the connection attempt, so it is recommended to only use it in scenarios where you know the site you're trying to connect o may not exist and would like to have feedback on this during the connect.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureADLoginEndPoint</maml:name> <maml:description> <maml:para>Custom Azure AD login endpoint to be used if we are using Azure Custom environment to retrieve access token. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The Client ID of the Azure AD Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be reused by the new connection. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> <maml:para>When passed in, the ClientId/AppId used for the passed in connection will be used for the new connection. It will override any -ClientId or -AppId parameter passed in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DeviceLogin</maml:name> <maml:description> <maml:para>Log in using the Device Code flow. You will be asked to consent to:</maml:para> <maml:para>* Read and write managed metadata * Have full control of all site collections * Read user profiles * Invite guest users to the organization * Read and write all groups * Read and write directory data * Read and write identity providers * Access the directory as you</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>MicrosoftGraphEndPoint</maml:name> <maml:description> <maml:para>Custom Microsoft Graph endpoint to be used if we are using Azure Custom environment. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PersistLogin</maml:name> <maml:description> <maml:para>Persist the current access token and related information in a locally stored cache. This cache will be retained between PowerShell sessions and will also be available after a reboot. You only need to provide this switch one time on Connect-PnPOnline cmdlet, it will after that retain the information and reuse it for new connections to the same tenant. Notice that while using a cached token, if you change the permissions of an application registration, the token associated with that registration will not be updated automatically in the cache. You will have to clear the cache entry first and reauthenticate: use `Disconnect-PnPOnline -ClearPersistedLogin`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets. It will not touch the current connection which can be established by omitting this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection or subsite to connect to, i.e. tenant.sharepoint.com, https://tenant.sharepoint.com, tenant.sharepoint.com/sites/hr, etc.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>ValidateConnection</maml:name> <maml:description> <maml:para>When provided, the cmdlet will check to ensure the SharePoint Online site specified through `-Url` exists and if not, will throw an exception. If you omit this flag or set it to $false, it will blindly set up a connection without validating that the site actually exists. Making use of this option does make one extra call on the connection attempt, so it is recommended to only use it in scenarios where you know the site you're trying to connect o may not exist and would like to have feedback on this during the connect.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Using this parameter you can provide your own access token. Notice that it is recommend to use one of the other connection methods as this will limits the offered functionality on PnP PowerShell. For instance if the token expires (typically after 1 hour) will not be able to acquire a new valid token, which the other connection methods do allow. You are responsible for providing your own valid access token when using this parameter, for the correct audience, with the correct permissions scopes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureADLoginEndPoint</maml:name> <maml:description> <maml:para>Custom Azure AD login endpoint to be used if we are using Azure Custom environment to retrieve access token. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>MicrosoftGraphEndPoint</maml:name> <maml:description> <maml:para>Custom Microsoft Graph endpoint to be used if we are using Azure Custom environment. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets. It will not touch the current connection which can be established by omitting this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection or subsite to connect to, i.e. tenant.sharepoint.com, https://tenant.sharepoint.com, tenant.sharepoint.com/sites/hr, etc.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>ValidateConnection</maml:name> <maml:description> <maml:para>When provided, the cmdlet will check to ensure the SharePoint Online site specified through `-Url` exists and if not, will throw an exception. If you omit this flag or set it to $false, it will blindly set up a connection without validating that the site actually exists. Making use of this option does make one extra call on the connection attempt, so it is recommended to only use it in scenarios where you know the site you're trying to connect o may not exist and would like to have feedback on this during the connect.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ManagedIdentity</maml:name> <maml:description> <maml:para>Connects using an Azure Managed Identity. For use with Azure Functions, Azure Automation Runbooks (if configured to use a managed identity) or Azure Cloud Shell only. This method will acquire a token using the built-in endpoints in the Azure Cloud Shell, Azure Automation Runbooks and Azure Functions. Read up on [the documentation](https://pnp.github.io/powershell/articles/azurefunctions.html#by-using-a-managed-identity) on how to make use of this option.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ManagedIdentity</maml:name> <maml:description> <maml:para>Connects using an Azure Managed Identity. For use with Azure Functions, Azure Automation Runbooks (if configured to use a managed identity) or Azure Cloud Shell only. This method will acquire a token using the built-in endpoints in the Azure Cloud Shell, Azure Automation Runbooks and Azure Functions. Read up on [the documentation](https://pnp.github.io/powershell/articles/azurefunctions.html#by-using-a-managed-identity) on how to make use of this option.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UserAssignedManagedIdentityClientId</maml:name> <maml:description> <maml:para>Can be used in combination with `-ManagedIdentity` to specify the client id of the user assigned managed identity to use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ManagedIdentity</maml:name> <maml:description> <maml:para>Connects using an Azure Managed Identity. For use with Azure Functions, Azure Automation Runbooks (if configured to use a managed identity) or Azure Cloud Shell only. This method will acquire a token using the built-in endpoints in the Azure Cloud Shell, Azure Automation Runbooks and Azure Functions. Read up on [the documentation](https://pnp.github.io/powershell/articles/azurefunctions.html#by-using-a-managed-identity) on how to make use of this option.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UserAssignedManagedIdentityObjectId</maml:name> <maml:description> <maml:para>Can be used in combination with `-ManagedIdentity` to specify the object/principal id of the user assigned managed identity to use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ManagedIdentity</maml:name> <maml:description> <maml:para>Connects using an Azure Managed Identity. For use with Azure Functions, Azure Automation Runbooks (if configured to use a managed identity) or Azure Cloud Shell only. This method will acquire a token using the built-in endpoints in the Azure Cloud Shell, Azure Automation Runbooks and Azure Functions. Read up on [the documentation](https://pnp.github.io/powershell/articles/azurefunctions.html#by-using-a-managed-identity) on how to make use of this option.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UserAssignedManagedIdentityAzureResourceId</maml:name> <maml:description> <maml:para>Can be used in combination with `-ManagedIdentity` to specify the Azure Resource ID of the user assigned managed identity to use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureADLoginEndPoint</maml:name> <maml:description> <maml:para>Custom Azure AD login endpoint to be used if we are using Azure Custom environment to retrieve access token. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be reused by the new connection. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> <maml:para>When passed in, the ClientId/AppId used for the passed in connection will be used for the new connection. It will override any -ClientId or -AppId parameter passed in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EnvironmentVariable</maml:name> <maml:description> <maml:para>Connects using the necessary environment variables. For more information the required environment variables, please refer to this article, [Azure.Identity Environment Variables](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables) here. We support only Service principal with certificate and Username with password mode for authentication. Configuration will be attempted in that order. For example, if values for a certificate and username+password are both present, the client certificate method will be used. By default, it will use the `-ClientId` specified in `AZURE_CLIENT_ID` environment variable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>MicrosoftGraphEndPoint</maml:name> <maml:description> <maml:para>Custom Microsoft Graph endpoint to be used if we are using Azure Custom environment. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets. It will not touch the current connection which can be established by omitting this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>The Azure Active Directory tenant name, e.g. mycompany.onmicrosoft.com or mycompany.com if you have added custom domains to your tenant</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TransformationOnPrem</maml:name> <maml:description> <maml:para>If you want to the use page transformation cmdlets, setting this switch will allow you to connect to an on-prem server. Notice that this -only- applies to Transformation cmdlets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection or subsite to connect to, i.e. tenant.sharepoint.com, https://tenant.sharepoint.com, tenant.sharepoint.com/sites/hr, etc.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>ValidateConnection</maml:name> <maml:description> <maml:para>When provided, the cmdlet will check to ensure the SharePoint Online site specified through `-Url` exists and if not, will throw an exception. If you omit this flag or set it to $false, it will blindly set up a connection without validating that the site actually exists. Making use of this option does make one extra call on the connection attempt, so it is recommended to only use it in scenarios where you know the site you're trying to connect o may not exist and would like to have feedback on this during the connect.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureADWorkloadIdentity</maml:name> <maml:description> <maml:para>Connects using the Azure AD Workload Identity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets. It will not touch the current connection which can be established by omitting this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection or subsite to connect to, i.e. tenant.sharepoint.com, https://tenant.sharepoint.com, tenant.sharepoint.com/sites/hr, etc.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>ValidateConnection</maml:name> <maml:description> <maml:para>When provided, the cmdlet will check to ensure the SharePoint Online site specified through `-Url` exists and if not, will throw an exception. If you omit this flag or set it to $false, it will blindly set up a connection without validating that the site actually exists. Making use of this option does make one extra call on the connection attempt, so it is recommended to only use it in scenarios where you know the site you're trying to connect o may not exist and would like to have feedback on this during the connect.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PnPOnline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OSLogin</maml:name> <maml:description> <maml:para>Connects using Web Account Manager (WAM). This works only on Windows machines, on other OS will open browser. Use this to open the native Windows authentication prompt. It supports Windows Hello, conditional access policies, FIDO keys and other OS integration auth options. Requires that the Entra ID app registration have `ms-appx-web://microsoft.aad.brokerplugin/{client_id}` as a redirect URI. For more information, visit this [link](https://learn.microsoft.com/en-us/entra/msal/dotnet/acquiring-tokens/desktop-mobile/wam).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Using this parameter you can provide your own access token. Notice that it is recommend to use one of the other connection methods as this will limits the offered functionality on PnP PowerShell. For instance if the token expires (typically after 1 hour) will not be able to acquire a new valid token, which the other connection methods do allow. You are responsible for providing your own valid access token when using this parameter, for the correct audience, with the correct permissions scopes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureADLoginEndPoint</maml:name> <maml:description> <maml:para>Custom Azure AD login endpoint to be used if we are using Azure Custom environment to retrieve access token. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureADWorkloadIdentity</maml:name> <maml:description> <maml:para>Connects using the Azure AD Workload Identity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AzureEnvironment</maml:name> <maml:description> <maml:para>The Azure environment to use for authentication, the defaults to 'Production' which is the main Azure environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CertificateBase64Encoded</maml:name> <maml:description> <maml:para>Specify a base64 encoded string as representing the private certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CertificatePassword</maml:name> <maml:description> <maml:para>Password to the certificate (*.pfx)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CertificatePath</maml:name> <maml:description> <maml:para>Path to the certificate containing the private key (*.pfx)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>The Client ID of the Azure AD Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>The client secret to use. When using this, technically an Azure Access Control Service (ACS) authentication will take place. This effectively means only cmdlets that are connecting to SharePoint Online will work. Cmdlets using Microsoft Graph or any other API behind the scenes will not work.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be reused by the new connection. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> <maml:para>When passed in, the ClientId/AppId used for the passed in connection will be used for the new connection. It will override any -ClientId or -AppId parameter passed in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>Credentials of the user to connect with. Either specify a PSCredential object or a string. In case of a string value a lookup will be done to the Generic Credentials section of the Windows Credentials in the Windows Credential Manager for the correct credentials.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CredentialPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CurrentCredentials</maml:name> <maml:description> <maml:para>Use credentials of the currently logged in user. Applicable exclusively when connecting to on premises SharePoint Server via PnP. Switch parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CredentialPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DeviceLogin</maml:name> <maml:description> <maml:para>Log in using the Device Code flow. You will be asked to consent to:</maml:para> <maml:para>* Read and write managed metadata * Have full control of all site collections * Read user profiles * Invite guest users to the organization * Read and write all groups * Read and write directory data * Read and write identity providers * Access the directory as you</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EnvironmentVariable</maml:name> <maml:description> <maml:para>Connects using the necessary environment variables. For more information the required environment variables, please refer to this article, [Azure.Identity Environment Variables](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables) here. We support only Service principal with certificate and Username with password mode for authentication. Configuration will be attempted in that order. For example, if values for a certificate and username+password are both present, the client certificate method will be used. By default, it will use the `-ClientId` specified in `AZURE_CLIENT_ID` environment variable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ForceAuthentication</maml:name> <maml:description> <maml:para>Will clear the stored authentication information when using Interactive login (all platforms) and allows you to authenticate again towards a site with different credentials.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Connects to the Entra ID (Azure AD) using interactive login, allowing you to authenticate using multi-factor authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ManagedIdentity</maml:name> <maml:description> <maml:para>Connects using an Azure Managed Identity. For use with Azure Functions, Azure Automation Runbooks (if configured to use a managed identity) or Azure Cloud Shell only. This method will acquire a token using the built-in endpoints in the Azure Cloud Shell, Azure Automation Runbooks and Azure Functions. Read up on [the documentation](https://pnp.github.io/powershell/articles/azurefunctions.html#by-using-a-managed-identity) on how to make use of this option.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>MicrosoftGraphEndPoint</maml:name> <maml:description> <maml:para>Custom Microsoft Graph endpoint to be used if we are using Azure Custom environment. This will only work if `AzureEnvironment` parameter value is set to `Custom`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OSLogin</maml:name> <maml:description> <maml:para>Connects using Web Account Manager (WAM). This works only on Windows machines, on other OS will open browser. Use this to open the native Windows authentication prompt. It supports Windows Hello, conditional access policies, FIDO keys and other OS integration auth options. Requires that the Entra ID app registration have `ms-appx-web://microsoft.aad.brokerplugin/{client_id}` as a redirect URI. For more information, visit this [link](https://learn.microsoft.com/en-us/entra/msal/dotnet/acquiring-tokens/desktop-mobile/wam).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PersistLogin</maml:name> <maml:description> <maml:para>Persist the current access token and related information in a locally stored cache. This cache will be retained between PowerShell sessions and will also be available after a reboot. You only need to provide this switch one time on Connect-PnPOnline cmdlet, it will after that retain the information and reuse it for new connections to the same tenant. Notice that while using a cached token, if you change the permissions of an application registration, the token associated with that registration will not be updated automatically in the cache. You will have to clear the cache entry first and reauthenticate: use `Disconnect-PnPOnline -ClearPersistedLogin`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RedirectUri</maml:name> <maml:description> <maml:para>The Redirect URI of the Azure AD Application</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReturnConnection</maml:name> <maml:description> <maml:para>Returns the connection for use with the -Connection parameter on cmdlets. It will not touch the current connection which can be established by omitting this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>The Azure Active Directory tenant name, e.g. mycompany.onmicrosoft.com or mycompany.com if you have added custom domains to your tenant</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>The thumbprint of the certificate containing the private key registered with the application in Azure Active Directory</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TransformationOnPrem</maml:name> <maml:description> <maml:para>If you want to the use page transformation cmdlets, setting this switch will allow you to connect to an on-prem server. Notice that this -only- applies to Transformation cmdlets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url of the site collection or subsite to connect to, i.e. tenant.sharepoint.com, https://tenant.sharepoint.com, tenant.sharepoint.com/sites/hr, etc.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UserAssignedManagedIdentityAzureResourceId</maml:name> <maml:description> <maml:para>Can be used in combination with `-ManagedIdentity` to specify the Azure Resource ID of the user assigned managed identity to use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UserAssignedManagedIdentityClientId</maml:name> <maml:description> <maml:para>Can be used in combination with `-ManagedIdentity` to specify the client id of the user assigned managed identity to use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UserAssignedManagedIdentityObjectId</maml:name> <maml:description> <maml:para>Can be used in combination with `-ManagedIdentity` to specify the object/principal id of the user assigned managed identity to use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>ValidateConnection</maml:name> <maml:description> <maml:para>When provided, the cmdlet will check to ensure the SharePoint Online site specified through `-Url` exists and if not, will throw an exception. If you omit this flag or set it to $false, it will blindly set up a connection without validating that the site actually exists. Making use of this option does make one extra call on the connection attempt, so it is recommended to only use it in scenarios where you know the site you're trying to connect o may not exist and would like to have feedback on this during the connect.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while going through setting up a connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>X509KeyStorageFlags</maml:name> <maml:description> <maml:para>Defines where and how to import the private key of an X.509 certificate.</maml:para> <maml:para>This enumeration supports a bitwise combination of its member values.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Security.Cryptography.X509Certificates.X509KeyStorageFlags</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.com" ```</maml:para> <maml:para>Connect to SharePoint prompting for the username and password. When a generic credential is added to the Windows Credential Manager with https://contoso.sharepoint.com, PowerShell will not prompt for username and password and use those stored credentials instead. You will have to register your own App first, by means of `Register-PnPEntraIDApp` to use this method. You will also have to provide the `-ClientId` parameter starting September 9, 2024. Alternatively, create an environment variable, call it `ENTRAID_APP_ID` or `ENTRAID_CLIENT_ID` and set the value to the app id you created</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.com" -Credentials (Get-Credential) ```</maml:para> <maml:para>Connect to SharePoint prompting for the username and password to use to authenticate.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.de" -ClientId 344b8aab-389c-4e4a-8fa1-4c1ae2c0a60d -ClientSecret $clientSecret ```</maml:para> <maml:para>This will authenticate you to the site using Legacy ACS authentication</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.com" -DeviceLogin -ClientId 6c5c98c7-e05a-4a0f-bcfa-0cfc65aa1f28 ```</maml:para> <maml:para>This will authenticate you using the specified Entra ID App registration. Alternatively, create an environment variable, call it `ENTRAID_APP_ID` or `ENTRAID_CLIENT_ID` and set the value to the app id you created. A browser window will automatically open and the code you need to enter will be automatically copied to your clipboard.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell $password = (ConvertTo-SecureString -AsPlainText 'myprivatekeypassword' -Force) Connect-PnPOnline -Url "https://contoso.sharepoint.com" -ClientId 6c5c98c7-e05a-4a0f-bcfa-0cfc65aa1f28 -CertificatePath 'c:\mycertificate.pfx' -CertificatePassword $password -Tenant 'contoso.onmicrosoft.com' ```</maml:para> <maml:para>Connects using an Azure Active Directory registered application using a locally available certificate containing a private key. See https://learn.microsoft.com/sharepoint/dev/solution-guidance/security-apponly-azuread for a sample on how to get started.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.com" -ClientId 6c5c98c7-e05a-4a0f-bcfa-0cfc65aa1f28 -Tenant 'contoso.onmicrosoft.com' -Thumbprint 34CFAA860E5FB8C44335A38A097C1E41EEA206AA ```</maml:para> <maml:para>Connects to SharePoint using app-only tokens via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. Ensure you have imported the private key certificate, typically the .pfx file, into the Windows Certificate Store for the certificate with the provided thumbprint.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.com" -ClientId 6c5c98c7-e05a-4a0f-bcfa-0cfc65aa1f28 -CertificateBase64Encoded $base64encodedstring -Tenant 'contoso.onmicrosoft.com' ```</maml:para> <maml:para>Connects using an Azure Active Directory registered application using a certificate with a private key that has been base64 encoded. See https://learn.microsoft.com/sharepoint/dev/solution-guidance/security-apponly-azuread for a sample on how to get started.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.com" -Interactive -ClientId 6c5c98c7-e05a-4a0f-bcfa-0cfc65aa1f28 ```</maml:para> <maml:para>Connects to the Azure AD, acquires an access token and allows PnP PowerShell to access both SharePoint and the Microsoft Graph. Notice that you will have to register your own App first, by means of `Register-PnPEntraIDApp` to use this method. You will also have to provide the `-ClientId` parameter starting September 9, 2024. Alternatively, create an environment variable, call it `ENTRAID_APP_ID` or `ENTRAID_CLIENT_ID` and set the value to the app id you created. If you use -Interactive and this environment variable is present you will not have to use -ClientId.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 9 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://portal.contoso.com" -TransformationOnPrem -CurrentCredential ```</maml:para> <maml:para>Connects to on-premises SharePoint 2013, 2016 or 2019 site with the current user's on-premises Windows credential (e.g. domain\user). This option is only supported for being able to transform on-premises classic wiki, webpart, blog and publishing pages into modern pages in a SharePoint Online site. Although other PnP cmdlets might work as well, they're officially not supported for being used in an on-premises context. See http://aka.ms/sharepoint/modernization/pages for more details on page transformation.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 10 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.com" -ManagedIdentity Get-PnPTeamsTeam ```</maml:para> <maml:para>Connects using a system assigned managed identity to Microsoft Graph. Using this way of connecting only works with environments that support managed identities: Azure Functions, Azure Automation Runbooks and the Azure Cloud Shell. Read up on [this article](https://pnp.github.io/powershell/articles/azurefunctions.html#by-using-a-managed-identity) how it can be used.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 11 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.com" -ManagedIdentity -UserAssignedManagedIdentityObjectId 363c1b31-6872-47fd-a616-574d3aec2a51 Get-PnPList ```</maml:para> <maml:para>Connects using an user assigned managed identity with object/principal ID 363c1b31-6872-47fd-a616-574d3aec2a51 to SharePoint Online. Using this way of connecting only works with environments that support managed identities: Azure Functions, Azure Automation Runbooks and the Azure Cloud Shell. Read up on [this article](https://pnp.github.io/powershell/articles/azurefunctions.html#by-using-a-managed-identity) how it can be used.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 12 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.com" -AccessToken $token ```</maml:para> <maml:para>This method assumes you have acquired a valid OAuth2 access token from Azure AD with the correct audience and permissions set. Using this method PnP PowerShell will not acquire tokens dynamically and if the token expires (typically after 1 hour) cmdlets will fail to work using this method.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 13 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url contoso.sharepoint.com -EnvironmentVariable -Tenant 'contoso.onmicrosoft.com' ```</maml:para> <maml:para>This example uses the `AZURE_CLIENT_CERTIFICATE_PATH` and `AZURE_CLIENT_CERTIFICATE_PASSWORD` environment variable values to authenticate. The `AZURE_CLIENT_ID` environment variable must be present and `Tenant` parameter value must be provided.</maml:para> <maml:para>If these environment variables are not present, it will try to find `ENTRAID_APP_CERTIFICATE_PATH` or `ENTRAID_CLIENT_CERTIFICATE_PATH` and for certificate password use `ENTRAID_APP_CERTIFICATE_PASSWORD` or `ENTRAID_CLIENT_CERTIFICATE_PASSWORD` as fallback.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 14 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url contoso.sharepoint.com -EnvironmentVariable ```</maml:para> <maml:para>This example uses the `AZURE_USERNAME` and `AZURE_PASSWORD` environment variables as credentials to authenticate. If these environment variables are not available, it will use `ENTRAID_USERNAME` and `ENTRAID_PASSWORD` environment variables as fallback.</maml:para> <maml:para>If `AZURE_CLIENT_ID` is not present, alternatively it will try to use `ENTRAID_APP_ID` or `ENTRAID_CLIENT_ID` environment variables as fallback.</maml:para> <maml:para>This method assumes you have the necessary environment variables available. For more information about the required environment variables, please refer to this article, [Azure.Identity Environment Variables](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables) here.</maml:para> <maml:para>So, when using `-EnvironmentVariable` method for authenticating, we will require `AZURE_CLIENT_CERTIFICATE_PATH`, `AZURE_CLIENT_CERTIFICATE_PASSWORD` and `AZURE_CLIENT_ID` environment variables for using the service principal with certificate method for authentication.</maml:para> <maml:para>If `AZURE_USERNAME`, `AZURE_PASSWORD` and `AZURE_CLIENT_ID`, we will use these environment variables and authenticate using credentials flow.</maml:para> <maml:para>If `ENTRAID_USERNAME`, `ENTRAID_PASSWORD` and `ENTRAID_APP_ID` , we will use these environment variables and authenticate using credentials flow.</maml:para> <maml:para>We support only Service principal with certificate and Username with password mode for authentication. Configuration will be attempted in that order. For example, if values for a certificate and username+password are both present, the client certificate method will be used.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 15 ---------</maml:title> <maml:introduction> <maml:para>``` Connect-PnPOnline -Url contoso.sharepoint.com -AzureEnvironment Custom -MicrosoftGraphEndPoint "custom.graph.microsoft.com" -AzureADLoginEndPoint "https://custom.login.microsoftonline.com" ```</maml:para> <maml:para>Use this method to connect to a custom Azure Environment. You can also specify the `MicrosoftGraphEndPoint` and `AzureADLoginEndPoint` parameters if applicable. If specified, then these values will be used to make requests to Graph and to retrieve access token.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 16 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url contoso.sharepoint.com -AzureADWorkloadIdentity ```</maml:para> <maml:para>This example uses Azure AD Workload Identity to retrieve access tokens. For more information about this, please refer to this article, [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/introduction.html). We are following the guidance mentioned in [this sample](https://github.com/Azure/azure-workload-identity/blob/main/examples/msal-net/akvdotnet/TokenCredential.cs) to retrieve the access tokens.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 17 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.com" -ClientId 6c5c98c7-e05a-4a0f-bcfa-0cfc65aa1f28 -OSLogin ```</maml:para> <maml:para>Connects to the Azure AD with WAM (aka native Windows authentication prompt), acquires an access token and allows PnP PowerShell to access both SharePoint and the Microsoft Graph. Notice that you will have to register your own App first, by means of Register-PnPEntraIDAdd to use this method. You will also have to provide the -ClientId parameter starting September 9, 2024. Alternatively, create an environment variable, call it `ENTRAID_APP_ID` or `ENTRAID_CLIENT_ID` and set the value to the app id you created.</maml:para> <maml:para>WAM is a more secure & faster way of authenticating in Windows OS. It supports Windows Hello, FIDO keys , conditional access policies and more.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 18 ---------</maml:title> <maml:introduction> <maml:para>```powershell $keyStorageflags = [System.Security.Cryptography.X509Certificates.X509KeyStorageFlags]::MachineKeySet -bor [System.Security.Cryptography.X509Certificates.X509KeyStorageFlags]::PersistKeySet</maml:para> <maml:para>Connect-PnPOnline -Url "contoso.sharepoint.com" -ClientId 6c5c98c7-e05a-4a0f-bcfa-0cfc65aa1f28 -CertificateBase64Encoded $base64encodedstring -X509KeyStorageFlags $keyStorageflags -Tenant 'contoso.onmicrosoft.com' ```</maml:para> <maml:para>Connects using an Azure Active Directory registered application using a certificate with a private key that has been base64 encoded. See [Security App-only EntraId guidance](https://learn.microsoft.com/sharepoint/dev/solution-guidance/security-apponly-azuread) for a sample on how to get started.</maml:para> <maml:para>See [X509 key storage flags](https://learn.microsoft.com/dotnet/api/system.security.cryptography.x509certificates.x509keystorageflags) for information on how to configure key storage when creating the certificate.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 19 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.com" -Credentials "https://contoso.sharepoint.com" ```</maml:para> <maml:para>Connect to SharePoint using Credentials (username and password) from Credential Manager (Windows) or Keychain (Mac) with the specified name to use to authenticate.</maml:para> <maml:para>On Windows, this entry needs to be under "Generic Credentials".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Convert-PnPFile</command:name> <maml:description> <maml:para>Converts a file to another format</maml:para> </maml:description> <command:verb>Convert</command:verb> <command:noun>PnPFile</command:noun> </command:details> <maml:description> <maml:para>Allows converting of a file from SharePoint Online. The file contents can either be directly saved to local disk, or stored in memory for further processing, or Can be uploaded back to SharePoint Online SiteCollection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Convert-PnPFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ConvertToFormat</maml:name> <maml:description> <maml:para>The format to which you want the file to be converted. Default is PDF.</maml:para> <maml:para>The following values are valid transformation targets and their supported source extensions:</maml:para> <maml:para>| Target | Description | Supported source extensions |:------|:-----------------------------------|--------------------------------- | glb | Converts the item into GLB format | cool, fbx, obj, ply, stl, 3mf | html | Converts the item into HTML format | eml, md, msg | jpg | Converts the item into JPG format | 3g2, 3gp, 3gp2, 3gpp, 3mf, ai, arw, asf, avi, bas, bash, bat, bmp, c, cbl, cmd, cool, cpp, cr2, crw, cs, css, csv, cur, dcm, dcm30, dic, dicm, dicom, dng, doc, docx, dwg, eml, epi, eps, epsf, epsi, epub, erf, fbx, fppx, gif, glb, h, hcp, heic, heif, htm, html, ico, icon, java, jfif, jpeg, jpg, js, json, key, log, m2ts, m4a, m4v, markdown, md, mef, mov, movie, mp3, mp4, mp4v, mrw, msg, mts, nef, nrw, numbers, obj, odp, odt, ogg, orf, pages, pano, pdf, pef, php, pict, pl, ply, png, pot, potm, potx, pps, ppsx, ppsxm, ppt, pptm, pptx, ps, ps1, psb, psd, py, raw, rb, rtf, rw1, rw2, sh, sketch, sql, sr2, stl, tif, tiff, ts, txt, vb, webm, wma, wmv, xaml, xbm, xcf, xd, xml, xpm, yaml, yml | pdf | Converts the item into PDF format | doc, docx, epub, eml, htm, html, md, msg, odp, ods, odt, pps, ppsx, ppt, pptx, rtf, tif, tiff, xls, xlsm, xlsx</maml:para> <maml:para>For more information, check [this link](https://pnp.github.io/pnpcore/using-the-sdk/files-intro.html#converting-files).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>NewFileName</maml:name> <maml:description> <maml:para>Filename to give the file local or on SharePoint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Convert-PnPFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsMemoryStream</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ConvertToFormat</maml:name> <maml:description> <maml:para>The format to which you want the file to be converted. Default is PDF.</maml:para> <maml:para>The following values are valid transformation targets and their supported source extensions:</maml:para> <maml:para>| Target | Description | Supported source extensions |:------|:-----------------------------------|--------------------------------- | glb | Converts the item into GLB format | cool, fbx, obj, ply, stl, 3mf | html | Converts the item into HTML format | eml, md, msg | jpg | Converts the item into JPG format | 3g2, 3gp, 3gp2, 3gpp, 3mf, ai, arw, asf, avi, bas, bash, bat, bmp, c, cbl, cmd, cool, cpp, cr2, crw, cs, css, csv, cur, dcm, dcm30, dic, dicm, dicom, dng, doc, docx, dwg, eml, epi, eps, epsf, epsi, epub, erf, fbx, fppx, gif, glb, h, hcp, heic, heif, htm, html, ico, icon, java, jfif, jpeg, jpg, js, json, key, log, m2ts, m4a, m4v, markdown, md, mef, mov, movie, mp3, mp4, mp4v, mrw, msg, mts, nef, nrw, numbers, obj, odp, odt, ogg, orf, pages, pano, pdf, pef, php, pict, pl, ply, png, pot, potm, potx, pps, ppsx, ppsxm, ppt, pptm, pptx, ps, ps1, psb, psd, py, raw, rb, rtf, rw1, rw2, sh, sketch, sql, sr2, stl, tif, tiff, ts, txt, vb, webm, wma, wmv, xaml, xbm, xcf, xd, xml, xpm, yaml, yml | pdf | Converts the item into PDF format | doc, docx, epub, eml, htm, html, md, msg, odp, ods, odt, pps, ppsx, ppt, pptx, rtf, tif, tiff, xls, xlsm, xlsx</maml:para> <maml:para>For more information, check [this link](https://pnp.github.io/pnpcore/using-the-sdk/files-intro.html#converting-files).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Convert-PnPFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ConvertToFormat</maml:name> <maml:description> <maml:para>The format to which you want the file to be converted. Default is PDF.</maml:para> <maml:para>The following values are valid transformation targets and their supported source extensions:</maml:para> <maml:para>| Target | Description | Supported source extensions |:------|:-----------------------------------|--------------------------------- | glb | Converts the item into GLB format | cool, fbx, obj, ply, stl, 3mf | html | Converts the item into HTML format | eml, md, msg | jpg | Converts the item into JPG format | 3g2, 3gp, 3gp2, 3gpp, 3mf, ai, arw, asf, avi, bas, bash, bat, bmp, c, cbl, cmd, cool, cpp, cr2, crw, cs, css, csv, cur, dcm, dcm30, dic, dicm, dicom, dng, doc, docx, dwg, eml, epi, eps, epsf, epsi, epub, erf, fbx, fppx, gif, glb, h, hcp, heic, heif, htm, html, ico, icon, java, jfif, jpeg, jpg, js, json, key, log, m2ts, m4a, m4v, markdown, md, mef, mov, movie, mp3, mp4, mp4v, mrw, msg, mts, nef, nrw, numbers, obj, odp, odt, ogg, orf, pages, pano, pdf, pef, php, pict, pl, ply, png, pot, potm, potx, pps, ppsx, ppsxm, ppt, pptm, pptx, ps, ps1, psb, psd, py, raw, rb, rtf, rw1, rw2, sh, sketch, sql, sr2, stl, tif, tiff, ts, txt, vb, webm, wma, wmv, xaml, xbm, xcf, xd, xml, xpm, yaml, yml | pdf | Converts the item into PDF format | doc, docx, epub, eml, htm, html, md, msg, odp, ods, odt, pps, ppsx, ppt, pptx, rtf, tif, tiff, xls, xlsm, xlsx</maml:para> <maml:para>For more information, check [this link](https://pnp.github.io/pnpcore/using-the-sdk/files-intro.html#converting-files).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsMemoryStream</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ConvertToFormat</maml:name> <maml:description> <maml:para>The format to which you want the file to be converted. Default is PDF.</maml:para> <maml:para>The following values are valid transformation targets and their supported source extensions:</maml:para> <maml:para>| Target | Description | Supported source extensions |:------|:-----------------------------------|--------------------------------- | glb | Converts the item into GLB format | cool, fbx, obj, ply, stl, 3mf | html | Converts the item into HTML format | eml, md, msg | jpg | Converts the item into JPG format | 3g2, 3gp, 3gp2, 3gpp, 3mf, ai, arw, asf, avi, bas, bash, bat, bmp, c, cbl, cmd, cool, cpp, cr2, crw, cs, css, csv, cur, dcm, dcm30, dic, dicm, dicom, dng, doc, docx, dwg, eml, epi, eps, epsf, epsi, epub, erf, fbx, fppx, gif, glb, h, hcp, heic, heif, htm, html, ico, icon, java, jfif, jpeg, jpg, js, json, key, log, m2ts, m4a, m4v, markdown, md, mef, mov, movie, mp3, mp4, mp4v, mrw, msg, mts, nef, nrw, numbers, obj, odp, odt, ogg, orf, pages, pano, pdf, pef, php, pict, pl, ply, png, pot, potm, potx, pps, ppsx, ppsxm, ppt, pptm, pptx, ps, ps1, psb, psd, py, raw, rb, rtf, rw1, rw2, sh, sketch, sql, sr2, stl, tif, tiff, ts, txt, vb, webm, wma, wmv, xaml, xbm, xcf, xd, xml, xpm, yaml, yml | pdf | Converts the item into PDF format | doc, docx, epub, eml, htm, html, md, msg, odp, ods, odt, pps, ppsx, ppt, pptx, rtf, tif, tiff, xls, xlsm, xlsx</maml:para> <maml:para>For more information, check [this link](https://pnp.github.io/pnpcore/using-the-sdk/files-intro.html#converting-files).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The destination library in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>NewFileName</maml:name> <maml:description> <maml:para>Filename to give the file local or on SharePoint</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPFile -Url "/sites/demo/Shared Documents/Document.docx" -AsMemoryStream ```</maml:para> <maml:para>Retrieves the file and converts to PDF, and outputs its content to the console as a Memory Stream</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPFile -Url "/sites/demo/Shared Documents/Document.docx" ```</maml:para> <maml:para>Retrieves the file and converts to PDF, and outputs its content to the console as a Memory Stream</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPFile -Url "/sites/demo/Shared Documents/Document.docx" -Path "C:\Temp" ```</maml:para> <maml:para>Retrieves the file and converts to PDF, and save it to the given local path</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPFile -Url "/sites/demo/Shared Documents/Document.docx" -Path "C:\Temp" -Force ```</maml:para> <maml:para>Retrieves the file and converts to PDF, and save it to the given local path. Force parameter will override the existing file in the location where the document gets saved.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPFile -Url "/sites/demo/Shared Documents/Test/Book.xlsx" -Folder "/sites/demo/Shared Documents/Archive" ```</maml:para> <maml:para>Retrieves the file and converts to PDF, and save it to the given Document library (Folder) in SharePoint Online (same site collection)</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPFile -Url "/sites/demo/Shared Documents/Test/Book.png" -ConvertToFormat Jpg -Folder "/sites/demo/Shared Documents/Archive" ```</maml:para> <maml:para>Retrieves the file and converts to JPG, and save it to the given Document library (Folder) in SharePoint Online (same site collection)</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPFile -Url "/sites/demo/Shared Documents/Test/Book.xlsx" -Folder "/sites/demo/Shared Documents/Archive" -NewFileName "differentname.pdf" ```</maml:para> <maml:para>Retrieves the file and converts to PDF, and save it to the given Document library (Folder) in SharePoint Online (same site collection) giving it the filename differentname.pdf</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Convert-PnPFolderToSiteTemplate</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> <command:verb>Convert</command:verb> <command:noun>PnPFolderToSiteTemplate</command:noun> </command:details> <maml:description> <maml:para>Allows to convert the current folder together with all files, to a pnp package file of and existing template xml.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Convert-PnPFolderToSiteTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPFolderToSiteTemplate -Out template.pnp ```</maml:para> <maml:para>Creates a pnp package file of an existing template xml, and includes all files in the current folder</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPFolderToSiteTemplate -Out template.pnp -Folder c:\temp ```</maml:para> <maml:para>Creates a pnp package file of an existing template xml, and includes all files in the c:\temp folder</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Convert-PnPSiteTemplate</command:name> <maml:description> <maml:para>Converts a provisioning template to an other schema version</maml:para> </maml:description> <command:verb>Convert</command:verb> <command:noun>PnPSiteTemplate</command:noun> </command:details> <maml:description> <maml:para>Allows to convert a provisioning template to an other schema version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Convert-PnPSiteTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <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" variableLength="true">XMLPnPSchemaVersion</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <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" variableLength="true">XMLPnPSchemaVersion</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPSiteTemplate -Path template.xml ```</maml:para> <maml:para>Converts a provisioning template to the latest schema and outputs the result to current console.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPSiteTemplate -Path template.xml -Out newtemplate.xml ```</maml:para> <maml:para>Converts a provisioning template to the latest schema and outputs the result the newtemplate.xml file.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPSiteTemplate -Path template.xml -Out newtemplate.xml -ToSchema V201512 ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Encoding documentation</maml:linkText> <command:uri>https://learn.microsoft.com/dotnet/api/system.text.encoding?view=net-8.0</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Convert-PnPSiteTemplateToMarkdown</command:name> <maml:description> <maml:para>Converts an existing PnP Site Template to a markdown report</maml:para> </maml:description> <command:verb>Convert</command:verb> <command:noun>PnPSiteTemplateToMarkdown</command:noun> </command:details> <maml:description> <maml:para>Converts an existing PnP Site Template to markdown report. Notice that this cmdlet is work in work progress, and the completeness of the report will increase in the future.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Convert-PnPSiteTemplateToMarkdown</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Out</maml:name> <maml:description> <maml:para>The output file name to write the report to in markdown format.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TemplatePath</maml:name> <maml:description> <maml:para>The path to an existing PnP Site Template</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Out</maml:name> <maml:description> <maml:para>The output file name to write the report to in markdown format.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TemplatePath</maml:name> <maml:description> <maml:para>The path to an existing PnP Site Template</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPSiteTemplateToMarkdown -TemplatePath ./mytemplate.xml ```</maml:para> <maml:para>This will convert the site template to a markdown file and outputs the result to the console.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Convert-PnPSiteTemplateToMarkdown -TemplatePath ./mytemplate.xml -Out ./myreport.md ```</maml:para> <maml:para>This will convert the site template to a markdown file and writes the result to the specified myreport.md file.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>ConvertTo-PnPPage</command:name> <maml:description> <maml:para>Converts a classic page (wiki or web part page) into a modern page</maml:para> </maml:description> <command:verb>ConvertTo</command:verb> <command:noun>PnPPage</command:noun> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-PnPPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AddPageAcceptBanner</maml:name> <maml:description> <maml:para>Adds the page accept banner web part. The actual web part is specified in webpartmapping.xml file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AddTableListImageAsImageWebPart</maml:name> <maml:description> <maml:para>When an image lives inside a table/list then it's also created as separate image web part underneath that table/list by default. Use this switch set to $false to change that</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>BlogPage</maml:name> <maml:description> <maml:para>I'm transforming a blog page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClearCache</maml:name> <maml:description> <maml:para>Clears the cache. Can be needed if you've installed a new web part to the site and want to use that in a custom webpartmapping file. Restarting your PS session has the same effect</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CopyPageMetadata</maml:name> <maml:description> <maml:para>Copies the page metadata to the created modern page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DelveBlogPage</maml:name> <maml:description> <maml:para>I'm transforming a Delve blog page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DelveKeepSubTitle</maml:name> <maml:description> <maml:para>Transform the possible sub title as topic header on the modern page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisablePageComments</maml:name> <maml:description> <maml:para>Disable comments for the created modern page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DontPublish</maml:name> <maml:description> <maml:para>Don't publish the created modern page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder to load the provided page from. If not provided all folders are searched</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page to convert</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>KeepPageCreationModificationInformation</maml:name> <maml:description> <maml:para>Keep the author, editor, created and modified information from the source page (when source page lives in SPO)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LDAPConnectionString</maml:name> <maml:description> <maml:para>Specifies a LDAP connection string e.g. LDAP://OU=Users,DC=Contoso,DC=local</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Library</maml:name> <maml:description> <maml:para>The name of the library containing the page. If SitePages then please omit this parameter</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LogFolder</maml:name> <maml:description> <maml:para>Folder in where the log file will be created (if LogType==File)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LogSkipFlush</maml:name> <maml:description> <maml:para>By default each cmdlet invocation will result in a log file, use the -SkipLogFlush to delay the log flushing. The first call without -SkipLogFlush will then write all log entries to a single log</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LogType</maml:name> <maml:description> <maml:para>Allows to generate a transformation log (File | SharePoint)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PageTransformatorLogType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LogVerbose</maml:name> <maml:description> <maml:para>Configure logging to include verbose log entries</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrites page if already existing</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PageLayoutMapping</maml:name> <maml:description> <maml:para>Path and name of the page layout mapping file driving the publishing page transformation</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PostAsNews</maml:name> <maml:description> <maml:para>Post the created, and published, modern page as news</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PublishingPage</maml:name> <maml:description> <maml:para>I'm transforming a publishing page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PublishingTargetPageName</maml:name> <maml:description> <maml:para>Name for the target page (only applies to publishing page transformation)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RemoveEmptySectionsAndColumns</maml:name> <maml:description> <maml:para>Remove empty sections and columns after transformation of the page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReplaceHomePageWithDefault</maml:name> <maml:description> <maml:para>Replaces a home page with a default stock modern home page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SetAuthorInPageHeader</maml:name> <maml:description> <maml:para>Set's the author of the source page as author in the modern page header (when source page lives in SPO)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipDefaultUrlRewriting</maml:name> <maml:description> <maml:para>Set this flag to prevent the default URL rewriting while you still want to do URL rewriting using a custom URL mapping file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipHiddenWebParts</maml:name> <maml:description> <maml:para>Set this flag to skip hidden webparts during transformation</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipItemLevelPermissionCopyToClientSidePage</maml:name> <maml:description> <maml:para>By default the item level permissions on a page are copied to the created client side page. Use this switch to prevent the copy</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipTermStoreMapping</maml:name> <maml:description> <maml:para>Disables term mapping during transformation</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipUrlRewriting</maml:name> <maml:description> <maml:para>If transforming cross site then by default urls in html and summarylinks are rewritten for the target site. Set this flag to prevent that</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipUserMapping</maml:name> <maml:description> <maml:para>Disables user mapping during transformation</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SummaryLinksToHtml</maml:name> <maml:description> <maml:para>By default summarylinks web parts are replaced by QuickLinks, but you can transform to plain html by setting this switch</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TakeSourcePageName</maml:name> <maml:description> <maml:para>Created client side page takes name from previous classic page. Classic page gets renamed to previous_&lt;Page&gt;.aspx</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TargetConnection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TargetPageFolder</maml:name> <maml:description> <maml:para>Folder to create the target page in (will be used in conjunction with auto-generated folders that ensure page name uniqueness)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TargetPageFolderOverridesDefaultFolder</maml:name> <maml:description> <maml:para>When setting a target page folder then the target page folder overrides possibly default folder path (e.g. in the source page lived in a folder) instead of being appended to it</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TargetPageName</maml:name> <maml:description> <maml:para>Name for the target page (only applies when doing cross site page transformation)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TargetWebUrl</maml:name> <maml:description> <maml:para>Url of the target web that will receive the modern page. Defaults to null which means in-place transformation</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TermMappingFile</maml:name> <maml:description> <maml:para>Specifies a taxonomy term mapping file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UrlMappingFile</maml:name> <maml:description> <maml:para>File holding custom URL mapping definitions</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UseCommunityScriptEditor</maml:name> <maml:description> <maml:para>Uses the community script editor (https://github.com/SharePoint/sp-dev-fx-webparts/tree/master/samples/react-script-editor) as replacement for the classic script editor web part</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UserMappingFile</maml:name> <maml:description> <maml:para>Specifies a user mapping file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebPartMappingFile</maml:name> <maml:description> <maml:para>Path and name of the web part mapping file driving the transformation</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AddPageAcceptBanner</maml:name> <maml:description> <maml:para>Adds the page accept banner web part. The actual web part is specified in webpartmapping.xml file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AddTableListImageAsImageWebPart</maml:name> <maml:description> <maml:para>When an image lives inside a table/list then it's also created as separate image web part underneath that table/list by default. Use this switch set to $false to change that</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>BlogPage</maml:name> <maml:description> <maml:para>I'm transforming a blog page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClearCache</maml:name> <maml:description> <maml:para>Clears the cache. Can be needed if you've installed a new web part to the site and want to use that in a custom webpartmapping file. Restarting your PS session has the same effect</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CopyPageMetadata</maml:name> <maml:description> <maml:para>Copies the page metadata to the created modern page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DelveBlogPage</maml:name> <maml:description> <maml:para>I'm transforming a Delve blog page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DelveKeepSubTitle</maml:name> <maml:description> <maml:para>Transform the possible sub title as topic header on the modern page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisablePageComments</maml:name> <maml:description> <maml:para>Disable comments for the created modern page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DontPublish</maml:name> <maml:description> <maml:para>Don't publish the created modern page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder to load the provided page from. If not provided all folders are searched</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page to convert</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>KeepPageCreationModificationInformation</maml:name> <maml:description> <maml:para>Keep the author, editor, created and modified information from the source page (when source page lives in SPO)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LDAPConnectionString</maml:name> <maml:description> <maml:para>Specifies a LDAP connection string e.g. LDAP://OU=Users,DC=Contoso,DC=local</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Library</maml:name> <maml:description> <maml:para>The name of the library containing the page. If SitePages then please omit this parameter</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LogFolder</maml:name> <maml:description> <maml:para>Folder in where the log file will be created (if LogType==File)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LogSkipFlush</maml:name> <maml:description> <maml:para>By default each cmdlet invocation will result in a log file, use the -SkipLogFlush to delay the log flushing. The first call without -SkipLogFlush will then write all log entries to a single log</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LogType</maml:name> <maml:description> <maml:para>Allows to generate a transformation log (File | SharePoint)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PageTransformatorLogType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LogVerbose</maml:name> <maml:description> <maml:para>Configure logging to include verbose log entries</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrites page if already existing</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PageLayoutMapping</maml:name> <maml:description> <maml:para>Path and name of the page layout mapping file driving the publishing page transformation</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PostAsNews</maml:name> <maml:description> <maml:para>Post the created, and published, modern page as news</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PublishingPage</maml:name> <maml:description> <maml:para>I'm transforming a publishing page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PublishingTargetPageName</maml:name> <maml:description> <maml:para>Name for the target page (only applies to publishing page transformation)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RemoveEmptySectionsAndColumns</maml:name> <maml:description> <maml:para>Remove empty sections and columns after transformation of the page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReplaceHomePageWithDefault</maml:name> <maml:description> <maml:para>Replaces a home page with a default stock modern home page</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SetAuthorInPageHeader</maml:name> <maml:description> <maml:para>Set's the author of the source page as author in the modern page header (when source page lives in SPO)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipDefaultUrlRewriting</maml:name> <maml:description> <maml:para>Set this flag to prevent the default URL rewriting while you still want to do URL rewriting using a custom URL mapping file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipHiddenWebParts</maml:name> <maml:description> <maml:para>Set this flag to skip hidden webparts during transformation</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipItemLevelPermissionCopyToClientSidePage</maml:name> <maml:description> <maml:para>By default the item level permissions on a page are copied to the created client side page. Use this switch to prevent the copy</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipTermStoreMapping</maml:name> <maml:description> <maml:para>Disables term mapping during transformation</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipUrlRewriting</maml:name> <maml:description> <maml:para>If transforming cross site then by default urls in html and summarylinks are rewritten for the target site. Set this flag to prevent that</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipUserMapping</maml:name> <maml:description> <maml:para>Disables user mapping during transformation</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SummaryLinksToHtml</maml:name> <maml:description> <maml:para>By default summarylinks web parts are replaced by QuickLinks, but you can transform to plain html by setting this switch</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TakeSourcePageName</maml:name> <maml:description> <maml:para>Created client side page takes name from previous classic page. Classic page gets renamed to previous_&lt;Page&gt;.aspx</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TargetConnection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TargetPageFolder</maml:name> <maml:description> <maml:para>Folder to create the target page in (will be used in conjunction with auto-generated folders that ensure page name uniqueness)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TargetPageFolderOverridesDefaultFolder</maml:name> <maml:description> <maml:para>When setting a target page folder then the target page folder overrides possibly default folder path (e.g. in the source page lived in a folder) instead of being appended to it</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TargetPageName</maml:name> <maml:description> <maml:para>Name for the target page (only applies when doing cross site page transformation)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TargetWebUrl</maml:name> <maml:description> <maml:para>Url of the target web that will receive the modern page. Defaults to null which means in-place transformation</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TermMappingFile</maml:name> <maml:description> <maml:para>Specifies a taxonomy term mapping file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UrlMappingFile</maml:name> <maml:description> <maml:para>File holding custom URL mapping definitions</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UseCommunityScriptEditor</maml:name> <maml:description> <maml:para>Uses the community script editor (https://github.com/SharePoint/sp-dev-fx-webparts/tree/master/samples/react-script-editor) as replacement for the classic script editor web part</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UserMappingFile</maml:name> <maml:description> <maml:para>Specifies a user mapping file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebPartMappingFile</maml:name> <maml:description> <maml:para>Path and name of the web part mapping file driving the transformation</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "somepage.aspx" -Overwrite ```</maml:para> <maml:para>Converts a wiki/web part page named 'somepage' to a client side page</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "somepage.aspx" -Overwrite -WebPartMappingFile c:\contoso\webpartmapping.xml ```</maml:para> <maml:para>Converts a wiki/web part page named 'somepage' to a client side page using a custom provided mapping file</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "somepage.aspx" -Overwrite -AddPageAcceptBanner ```</maml:para> <maml:para>Converts a wiki/web part page named 'somepage' to a client side page and adds the page accept banner web part on top of the page. This requires that the SPFX solution holding the web part (https://github.com/SharePoint/sp-dev-modernization/blob/master/Solutions/PageTransformationUI/assets/sharepointpnp-pagetransformation-client.sppkg?raw=true) has been installed to the tenant app catalog</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "somepage.aspx" -Overwrite -CopyPageMetadata ```</maml:para> <maml:para>Converts a wiki/web part page named 'somepage' to a client side page, including the copying of the page metadata (if any)</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "somepage.aspx" -PublishingPage -Overwrite -TargetWebUrl "https://contoso.sharepoint.com/sites/targetmodernsite" ```</maml:para> <maml:para>Converts a publishing page named 'somepage' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "somepage.aspx" -PublishingPage -Overwrite -TargetConnection $target ```</maml:para> <maml:para>Converts a publishing page named 'somepage' to a client side page in the site specified by the TargetConnection connection. This allows to read a page in one environment (on-premises, tenant A) and create in another online location (tenant B)</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "somepage.aspx" -Library "SiteAssets" -Folder "Folder1" -Overwrite ```</maml:para> <maml:para>Converts a web part page named 'somepage' living inside the SiteAssets library in a folder named folder1 into a client side page</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "somepage.aspx" -Folder "<root>" -Overwrite ```</maml:para> <maml:para>Converts a web part page named 'somepage' living inside the root of the site collection (so outside of a library)</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 9 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "somepage.aspx" -Overwrite -TargetWebUrl "https://contoso.sharepoint.com/sites/targetmodernsite" ```</maml:para> <maml:para>Converts a wiki/web part page named 'somepage' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 10 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "somepage.aspx" -LogType File -LogFolder c:\temp -LogVerbose -Overwrite ```</maml:para> <maml:para>Converts a wiki/web part page named 'somepage' and creates a log file in c:\temp using verbose logging</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 11 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "somepage.aspx" -LogType SharePoint -LogSkipFlush ```</maml:para> <maml:para>Converts a wiki/web part page named 'somepage' and creates a log file in SharePoint but skip the actual write. Use this option to make multiple ConvertTo-PnPPage invocations create a single log</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 12 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "My post title" -BlogPage -LogType Console -Overwrite -TargetWebUrl "https://contoso.sharepoint.com/sites/targetmodernsite" ```</maml:para> <maml:para>Converts a blog page with a title starting with 'my post title' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 13 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "My post title" -DelveBlogPage -LogType Console -Overwrite -TargetWebUrl "https://contoso.sharepoint.com/sites/targetmodernsite" ```</maml:para> <maml:para>Converts a Delve blog page with a title starting with 'my post title' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 14 ---------</maml:title> <maml:introduction> <maml:para>```powershell ConvertTo-PnPPage -Identity "somepage.aspx" -PublishingPage -Overwrite -TargetConnection $target -UserMappingFile c:\\temp\user_mapping_file.csv ```</maml:para> <maml:para>Converts a publishing page named 'somepage' to a client side page in the site specified by the TargetConnection connection. This allows to read a page in on-premises environment and create in another online locations including using specific user mappings between the two environments.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Copy-PnPFile</command:name> <maml:description> <maml:para>Copies a file or folder to a different location</maml:para> </maml:description> <command:verb>Copy</command:verb> <command:noun>PnPFile</command:noun> </command:details> <maml:description> <maml:para>Copies a file or folder to a different location. This location can be within the same document library, same site, same site collection or even to another site collection on the same tenant. Notice that if copying between sites or to a subsite you cannot specify a target filename, only a folder name.</maml:para> <maml:para>Copying files and folders is bound to some restrictions. You can find more on it here: https://learn.microsoft.com/office365/servicedescriptions/sharepoint-online-service-description/sharepoint-online-limits#moving-and-copying-across-sites</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-PnPFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IgnoreVersionHistory</maml:name> <maml:description> <maml:para>If provided, only the latest version of the document will be copied and its history will be discarded. If not provided, all historical versions will be copied.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>NoWait</maml:name> <maml:description> <maml:para>If specified the task will return immediately after creating the copy job. The cmdlet will return a job object which can be used with Receive-PnPCopyMoveJobStatus to retrieve the status of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SourceUrl</maml:name> <maml:description> <maml:para>Site or server relative URL specifying the file or folder to copy. Must include the file name if it is a file or the entire path to the folder if it is a folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>TargetUrl</maml:name> <maml:description> <maml:para>Site or server relative URL where to copy the file or folder to. Must not include the file name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IgnoreVersionHistory</maml:name> <maml:description> <maml:para>If provided, only the latest version of the document will be copied and its history will be discarded. If not provided, all historical versions will be copied.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>NoWait</maml:name> <maml:description> <maml:para>If specified the task will return immediately after creating the copy job. The cmdlet will return a job object which can be used with Receive-PnPCopyMoveJobStatus to retrieve the status of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SourceUrl</maml:name> <maml:description> <maml:para>Site or server relative URL specifying the file or folder to copy. Must include the file name if it is a file or the entire path to the folder if it is a folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>TargetUrl</maml:name> <maml:description> <maml:para>Site or server relative URL where to copy the file or folder to. Must not include the file name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFile -SourceUrl "Shared Documents/MyProjectfiles" -TargetUrl "/sites/otherproject/Shared Documents" -Overwrite ```</maml:para> <maml:para>Copies a folder named MyProjectFiles 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. If a folder named MyProjectFiles already exists, it will overwrite it.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFile -SourceUrl "/sites/project/Shared Documents/company.docx" -TargetUrl "/sites/otherproject/Shared Documents" ```</maml:para> <maml:para>Copies a file named company.docx located in a document library called Shared Documents in the site collection project to the Shared Documents library in the site collection otherproject. If a file named company.docx already exists, it won't perform the copy.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFile -SourceUrl "Shared Documents/company.docx" -TargetUrl "/sites/otherproject/Shared Documents" -IgnoreVersionHistory ```</maml:para> <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. Only the latest version of the file will be copied and its history will be discarded.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFile -SourceUrl "/sites/project/Shared Documents/Archive" -TargetUrl "/sites/otherproject/Shared Documents" -Overwrite ```</maml:para> <maml:para>Copies a folder named Archive located in a document library called Shared Documents in the site collection project to the Shared Documents library in the site collection otherproject. If a folder named Archive already exists, it will overwrite it.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFile -SourceUrl "Documents/company.docx" -TargetUrl "Documents/company2.docx" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFile -SourceUrl "Shared Documents/company.docx" -TargetUrl "Shared Documents2/company.docx" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFile -SourceUrl "Shared DocuDocuments/company.docx" -TargetUrl "Subsite/Shared Documents" ```</maml:para> <maml:para>Copies a file named company.docx located in a document library called Documents to the document library named Documents in a subsite named Subsite keeping the file name.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFile -SourceUrl "Shared Documents/company.docx" -TargetUrl "/sites/otherproject/Shared Documents" -Overwrite ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 9 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFile -SourceUrl "Shared Documents/MyDocs" -TargetUrl "/sites/otherproject/Documents" -Overwrite ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 10 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFile -SourceUrl "SubSite1/Documents/company.docx" -TargetUrl "SubSite2/Documents" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 11 ---------</maml:title> <maml:introduction> <maml:para>```powershell $job = Copy-PnPFile -SourceUrl "Shared Documents/company.docx" -TargetUrl "SubSite2/Shared Documents" -NoWait $jobStatus = Receive-PnPCopyMoveJobStatus -Job $job if($jobStatus.JobState == 0) { Write-Host "Job finished" } ```</maml:para> <maml:para>Copies a file named company.docx from the current document library to the documents library in SubSite2. It will not wait for the action to return but returns job information instead. The Receive-PnPCopyMoveJobStatus cmdlet will return the job status.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Copy-PnPFolder</command:name> <maml:description> <maml:para>Copies a folder or file to a different location within SharePoint Online or allows uploading of an entire local folder with optionally subfolders to SharePoint Online.</maml:para> </maml:description> <command:verb>Copy</command:verb> <command:noun>PnPFolder</command:noun> </command:details> <maml:description> <maml:para>Copies a folder or file to a different location within SharePoiint. This location can be within the same document library, same site, same site collection or even to another site collection on the same tenant. Notice that if copying between sites or to a subsite you cannot specify a target filename, only a folder name.</maml:para> <maml:para>Copying files and folders is bound to some restrictions. You can find more on it here: https://learn.microsoft.com/office365/servicedescriptions/sharepoint-online-service-description/sharepoint-online-limits#moving-and-copying-across-sites</maml:para> <maml:para>It can also accommodate copying an entire folder with all its files and optionally even subfolders and files from a local path onto SharePoint Online.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-PnPFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</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 when copying between two locations on SharePoint Online. If copying files from a local path to SharePoint Online, it will skip any file that already exists and still continue with the next one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>TargetUrl</maml:name> <maml:description> <maml:para>Site or server relative URL where to copy the file or folder to. Must not include the file name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Copy-PnPFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</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 when copying between two locations on SharePoint Online. If copying files from a local path to SharePoint Online, it will skip any file that already exists and still continue with the next one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>TargetUrl</maml:name> <maml:description> <maml:para>Site or server relative URL where to copy the file or folder to. Must not include the file name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IgnoreVersionHistory</maml:name> <maml:description> <maml:para>If provided, only the latest version of the document will be copied and its history will be discarded. If not provided, all historical versions will be copied.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>NoWait</maml:name> <maml:description> <maml:para>If specified the task will return immediately after creating the copy job. The cmdlet will return a job object which can be used with Receive-PnPCopyMoveJobStatus to retrieve the status of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</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 when copying between two locations on SharePoint Online. If copying files from a local path to SharePoint Online, it will skip any file that already exists and still continue with the next one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When copying files from a local folder to SharePoint Online, this parameter will copy all files and folders within the local folder and all of its subfolders as well.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RemoveAfterCopy</maml:name> <maml:description> <maml:para>When copying files from a local folder to SharePoint Online, this parameter will remove all files locally that have successfully been uploaded to SharePoint Online. If a file fails, it will not be removed locally. Local folders will be removed after all files have been uploaded and the folder is empty.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SourceUrl</maml:name> <maml:description> <maml:para>Site or server relative URL specifying the file or folder to copy. Must include the file name if it is a file or the entire path to the folder if it is a folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>TargetUrl</maml:name> <maml:description> <maml:para>Site or server relative URL where to copy the file or folder to. Must not include the file name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFolder -SourceUrl "Shared Documents/MyProjectfiles" -TargetUrl "/sites/otherproject/Shared Documents" -Overwrite ```</maml:para> <maml:para>Copies a folder named MyProjectFiles 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. If a folder named MyProjectFiles already exists, it will overwrite it.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFolder -SourceUrl "/sites/project/Shared Documents/company.docx" -TargetUrl "/sites/otherproject/Shared Documents" ```</maml:para> <maml:para>Copies a file named company.docx located in a document library called Shared Documents in the site collection project to the Shared Documents library in the site collection otherproject. If a file named company.docx already exists, it won't perform the copy.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFolder -SourceUrl "Shared Documents/company.docx" -TargetUrl "/sites/otherproject/Shared Documents" -IgnoreVersionHistory ```</maml:para> <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. Only the latest version of the file will be copied and its history will be discarded.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFolder -SourceUrl "/sites/project/Shared Documents/Archive" -TargetUrl "/sites/otherproject/Shared Documents" -Overwrite ```</maml:para> <maml:para>Copies a folder named Archive located in a document library called Shared Documents in the site collection project to the Shared Documents library in the site collection otherproject. If a folder named Archive already exists, it will overwrite it.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFolder -SourceUrl "Documents/company.docx" -TargetUrl "Documents/company2.docx" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFolder -SourceUrl "Shared Documents/company.docx" -TargetUrl "Shared Documents2/company.docx" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFolder -SourceUrl "Shared DocuDocuments/company.docx" -TargetUrl "Subsite/Shared Documents" ```</maml:para> <maml:para>Copies a file named company.docx located in a document library called Documents to the document library named Documents in a subsite named Subsite keeping the file name.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFolder -SourceUrl "Shared Documents/company.docx" -TargetUrl "/sites/otherproject/Shared Documents" -Overwrite ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 9 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFolder -SourceUrl "Shared Documents/MyDocs" -TargetUrl "/sites/otherproject/Documents" -Overwrite ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 10 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFolder -SourceUrl "SubSite1/Documents/company.docx" -TargetUrl "SubSite2/Documents" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 11 ---------</maml:title> <maml:introduction> <maml:para>```powershell $job = Copy-PnPFolder -SourceUrl "Shared Documents/company.docx" -TargetUrl "SubSite2/Shared Documents" -NoWait $jobStatus = Receive-PnPCopyMoveJobStatus -Job $result if($jobStatus.JobState == 0) { Write-Host "Job finished" } ```</maml:para> <maml:para>Copies a file named company.docx from the current document library to the documents library in SubSite2. It will not wait for the action to return but returns job information instead. The Receive-PnPCopyMoveJobStatus cmdlet will return the job status.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 12 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPFolder -LocalPath "c:\temp" -TargetUrl "Subsite1/Shared Documents" -Recurse -Overwrite ```</maml:para> <maml:para>Copies all the files and underlying folders from the local folder c:\temp to the document library Shared Documents in Subsite1. If a file already exists, it will be overwritten.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Copy-PnPItemProxy</command:name> <maml:description> <maml:para>Copies an item from one location to another. It is an alias of the `Copy-Item` cmdlet.</maml:para> </maml:description> <command:verb>Copy</command:verb> <command:noun>PnPItemProxy</command:noun> </command:details> <maml:description> <maml:para>**This cmdlet is an alias of the `Copy-Item` cmdlet that is natively available with PowerShell**.</maml:para> <maml:para>The `Copy-PnPItemProxy` cmdlet copies an item from one location to another location in the same namespace. For instance, it can copy a file to a folder, but it can't copy a file to a certificate drive.</maml:para> <maml:para>This cmdlet doesn't cut or delete the items being copied. The particular items that the cmdlet can copy depend on the PowerShell provider that exposes the item. For instance, it can copy files and directories in a file system drive and registry keys and entries in the registry drive.</maml:para> <maml:para>This cmdlet can copy and rename items in the same command. To rename an item, enter the new name in the value of the Destination parameter. To rename an item and not copy it, use the Rename-Item cmdlet.</maml:para> <maml:para>For more information and details, please refer to the official PowerShell documentation [here](https://learn.microsoft.com/powershell/module/microsoft.powershell.management/copy-item).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-Item </maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Copy-PnPList</command:name> <maml:description> <maml:para>Creates a copy of an existing list</maml:para> </maml:description> <command:verb>Copy</command:verb> <command:noun>PnPList</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows an existing list to be copied to either the same site or to another site (same tenant). It copies the fields, views and settings of the list. It does not copy along the list items in the list. If you wish to copy a list from one tenant to another, you will have to export the list as a provisioning template, and then apply the template to the target tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-PnPList</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Switch parameter which executes the cmdlet but does not do the actual copy. Use in combination with -Verbose to see if all preconditions to be able to make a copy of the list are met without doing the actual copy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Copy-PnPList</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Switch parameter which executes the cmdlet but does not do the actual copy. Use in combination with -Verbose to see if all preconditions to be able to make a copy of the list are met without doing the actual copy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Copy-PnPList</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Switch parameter which executes the cmdlet but does not do the actual copy. Use in combination with -Verbose to see if all preconditions to be able to make a copy of the list are met without doing the actual copy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Copy-PnPList</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Switch parameter which executes the cmdlet but does not do the actual copy. Use in combination with -Verbose to see if all preconditions to be able to make a copy of the list are met without doing the actual copy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DestinationWebUrl</maml:name> <maml:description> <maml:para>Full SharePoint Online site URL to the site where the list should be copied to, i.e. https://contoso.sharepoint.com/sites/hrdepartment</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>List id, name or instance of a list you want to make a copy of</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SourceListUrl</maml:name> <maml:description> <maml:para>Full SharePoint Online list URL to the list you want to make a copy of, i.e. https://contoso.sharepoint.com/sites/hrdepartment/lists/mylist</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title to give to the new list which will be created by copying an existing list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Switch parameter which executes the cmdlet but does not do the actual copy. Use in combination with -Verbose to see if all preconditions to be able to make a copy of the list are met without doing the actual copy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPList -Identity "My List" -Title "Copy of My List" ```</maml:para> <maml:para>Copies the list "My List" located in the current site to "Copy of My List", also in the current site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPList -Identity "My List" -DestinationWebUrl https://contoso.sharepoint.com/sites/hrdepartment ```</maml:para> <maml:para>Copies the list "My List" to the site with the provided URL keeping the same list name</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPList -Identity "My List" -DestinationWebUrl https://contoso.sharepoint.com/sites/hrdepartment -Title "My copied list" ```</maml:para> <maml:para>Copies the list "My List" to the site with the provided URL changing the list name to "My copied list"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell $list = Get-PnPList -Identity "My List" Copy-PnPList -Identity $list -Title "My copied list" ```</maml:para> <maml:para>Copies the list "My List" to the site with the provided URL changing the list name to "My copied list"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPList | ? Title -like "*Test*" | Copy-PnPList -DestinationWebUrl https://contoso.sharepoint.com/sites/hrdepartment ```</maml:para> <maml:para>Copies all the lists on the current site having a title that contains "Test" to the site with the provided URL</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPList -SourceListUrl https://contoso.sharepoint.com/sites/templates/lists/mylist -Verbose -DestinationWebUrl https://contoso.sharepoint.com/sites/hrdepartment\ ```</maml:para> <maml:para>Copies the list located at the provided URL through -SourceListUrl to the site provided through -DestinationWebUrl</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Copy-PnPPage</command:name> <maml:description> <maml:para>Allows a site page to be moved from one site to another site.</maml:para> </maml:description> <command:verb>Copy</command:verb> <command:noun>PnPPage</command:noun> </command:details> <maml:description> <maml:para>This command allows a site page to be moved from one site to another site. The source and destination sites can be specified using the -SourceSite and -DestinationSite parameters, respectively. The page to be moved is specified using the -PageName parameter.</maml:para> <maml:para>Use [Get-PnPPageCopyProgress](Get-PnPPageCopyProgress.md) to check the progress of the page copy operation.</maml:para> <maml:para>Question: Will SharePoint pages retain their version history after the move? Answer: Currently, only the latest published version will be transferred.</maml:para> <maml:para>Question: Can recipients of SharePoint pages I shared with continue to access them after the move? Answer: All permissions will be removed once the pages are moved.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-PnPPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:description> <maml:para>The destination site to which the page should be moved. This can be specified as a URL or a site object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SPOSitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>PageName</maml:name> <maml:description> <maml:para>The name of the page to be moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>SourceSite</maml:name> <maml:description> <maml:para>The source site from which the page will be moved. This can be specified as a URL or a site object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SPOSitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:description> <maml:para>The destination site to which the page should be moved. This can be specified as a URL or a site object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SPOSitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>PageName</maml:name> <maml:description> <maml:para>The name of the page to be moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>SourceSite</maml:name> <maml:description> <maml:para>The source site from which the page will be moved. This can be specified as a URL or a site object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SPOSitePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPPage -SourceSite https://tenant.sharepoint.com/sites/site1 -DestinationSite https://tenant.sharepoint.com -PageName "FAQ.aspx" ```</maml:para> <maml:para>Moves the page named 'FAQ.aspx' from the site 'site1' to the root site of the tenant.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Online Management Shell equivallent</maml:linkText> <command:uri>https://learn.microsoft.com/powershell/module/sharepoint-online/copy-spopersonalsitepage</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Copy-PnPTeamsTeam</command:name> <maml:description> <maml:para>Creates a copy of a Microsoft Teams team</maml:para> </maml:description> <command:verb>Copy</command:verb> <command:noun>PnPTeamsTeam</command:noun> </command:details> <maml:description> <maml:para>Using this command, global admins and Microsoft Teams service admins can access teams that they are not a member of to make a copy of them.</maml:para> <maml:para>Creates a copy of a team. This operation also creates a copy of the corresponding group. You can specify which parts of the team to clone:</maml:para> <maml:para>apps - Copies Microsoft Teams apps that are installed in the team. channels – Copies the channel structure (but not the messages in the channel). members – Copies the members and owners of the group. settings – Copies all settings within the team, along with key group settings. tabs – Copies the tabs within channels.</maml:para> <maml:para>When tabs are cloned, they are put into an un configured state -- they are displayed on the tab bar in Microsoft Teams, and the first time you open them, you'll go through the configuration screen. If the person opening the tab does not have permission to configure apps, they will see a message explaining that the tab hasn't been configured.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-PnPTeamsTeam</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Classification</maml:name> <maml:description> <maml:para>Describes a classification for the group (such as low, medium or high business impact). If classification is not specified, the classification will be copied from the original team/group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the group. This property is required when a group is created and it cannot be cleared during updates. Supports $filter and $orderby.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PartsToClone</maml:name> <maml:description> <maml:para>A comma-separated list of the parts to clone. Allowed values are apps,channels,members,settings,tabs. When not provided, all available parts will be cloned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ClonableTeamParts</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the visibility of the group. Possible values are: Private, Public. If visibility is not specified, the visibility will be copied from the original team/group. If the team being cloned is an educationClass team, the visibility parameter is ignored, and the new group's visibility will be set to HiddenMembership.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">teamVisibilityType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Classification</maml:name> <maml:description> <maml:para>Describes a classification for the group (such as low, medium or high business impact). If classification is not specified, the classification will be copied from the original team/group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name for the group. This property is required when a group is created and it cannot be cleared during updates. Supports $filter and $orderby.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PartsToClone</maml:name> <maml:description> <maml:para>A comma-separated list of the parts to clone. Allowed values are apps,channels,members,settings,tabs. When not provided, all available parts will be cloned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ClonableTeamParts</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Specifies the visibility of the group. Possible values are: Private, Public. If visibility is not specified, the visibility will be copied from the original team/group. If the team being cloned is an educationClass team, the visibility parameter is ignored, and the new group's visibility will be set to HiddenMembership.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">teamVisibilityType</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPTeamsTeam -Identity ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e -DisplayName "Library Assist" -PartsToClone apps,tabs,settings,channels,members ``` Creates a clone of a Microsoft Teams team named "Library Assist" from Microsoft Teams team ID ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e with the apps,tabs,settings,channels and members</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPTeamsTeam -Identity "Team 12" -DisplayName "Library Assist" ``` Creates a clone of a Microsoft Teams team named "Library Assist" from Microsoft Teams team "Team 12" with the all the available parts</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPTeamsTeam -Identity "Team 12" -DisplayName "Library Assist" -PartsToClone apps,tabs,settings,channels,members -Description "Self help community for library" -Classification "Library" -Visibility public ``` Creates a clone of a Microsoft Teams team named "Library Assist" from Microsoft Teams team "Team 12" with the apps,tabs,settings,channels and members setting the classification to "Library", Visibility to public and Description to "Self help community for library"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Copy-PnPTeamsTeam -Identity "Team 12" -DisplayName "Library Assist" -PartsToClone settings,channels -Description "Self help community for library" -Classification "Library" -Visibility public ``` Creates a clone of a Microsoft Teams team named "Library Assist" from Microsoft Teams team "Team 12" with the settings and channels setting the classification to "Library", Visibility to public and Description to "Self help community for library"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Deny-PnPTenantServicePrincipalPermissionRequest</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Denies a permission request for the current tenant's "SharePoint Online Client" service principal</maml:para> </maml:description> <command:verb>Deny</command:verb> <command:noun>PnPTenantServicePrincipalPermissionRequest</command:noun> </command:details> <maml:description> <maml:para>Denies a permission request for the current tenant's "SharePoint Online Client" service principal</maml:para> <maml:para>Denying a permission request removes that request from the list of permission requests.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Deny-PnPTenantServicePrincipalPermissionRequest</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RequestId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RequestId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Disable-PnPFeature</command:name> <maml:description> <maml:para>Disables a feature</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>PnPFeature</command:noun> </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="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the feature to disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FeatureScope</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the feature to disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FeatureScope</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe ```</maml:para> <maml:para>This will disable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Force ```</maml:para> <maml:para>This will disable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with force.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Disable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Web ```</maml:para> <maml:para>This will disable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with the web scope.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Disable-PnPFlow</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: management.azure.com Disables a specific flow</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>PnPFlow</command:noun> </command:details> <maml:description> <maml:para>This cmdlet disables a specific flow</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-PnPFlow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>Disable the flow as an administrator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the flow to disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerAutomateFlowPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>Disable the flow as an administrator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the flow to disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerAutomateFlowPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Disable-PnPFlow -Identity fba63225-baf9-4d76-86a1-1b42c917a182 ```</maml:para> <maml:para>Disables the specified flow in the default environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Disable-PnPFlow -Environment (Get-PnPPowerPlatformEnvironment -Identity "myenvironment") -Identity fba63225-baf9-4d76-86a1-1b42c917a182 ```</maml:para> <maml:para>Disables the specified flow in the specified environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Disable-PnPPageScheduling</command:name> <maml:description> <maml:para>Disables the modern page schedule feature</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>PnPPageScheduling</command:noun> </command:details> <maml:description> <maml:para>This will disable page publishing scheduling on modern sites</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-PnPPageScheduling</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Disable-PnPPageScheduling ```</maml:para> <maml:para>This will disable page publishing scheduling on the current site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Disable-PnPPowerShellTelemetry</command:name> <maml:description> <maml:para>Disables sending of telemetry data.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>PnPPowerShellTelemetry</command:noun> </command:details> <maml:description> <maml:para>This cmdlet disables sending of telemetry data.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-PnPPowerShellTelemetry</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Switch parameter which executes the cmdlet and skips the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Disable-PnPPowerShellTelemetry</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Switch parameter which executes the cmdlet and skips the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Switch parameter which executes the cmdlet and skips the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Disable-PnPPowerShellTelemetry ```</maml:para> <maml:para>Disables sending to telemetry data after answering the confirmation question.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Disable-PnPPowerShellTelemetry -Force ```</maml:para> <maml:para>Disables sending to telemetry data skipping the confirmation question.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Disable-PnPSharingForNonOwnersOfSite</command:name> <maml:description> <maml:para>Configures the site to only allow sharing of the site and items in the site by owners</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>PnPSharingForNonOwnersOfSite</command:noun> </command:details> <maml:description> <maml:para>Configures the site to only allow sharing of the site and items in the site by owners. At this point there is no interface available yet to undo this action through script. You will have to do so through the user interface of SharePoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-PnPSharingForNonOwnersOfSite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Disable-PnPSharingForNonOwnersOfSite ```</maml:para> <maml:para>Restricts sharing of the site and items in the site only to owners</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Disable-PnPSiteClassification</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Directory.ReadWrite.All Disables Site Classifications for the tenant</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>PnPSiteClassification</command:noun> </command:details> <maml:description> <maml:para>Allows to disable site classifications for the tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-PnPSiteClassification</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Disable-PnPTenantServicePrincipal</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Disables the current tenant's "SharePoint Online Client" service principal.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>PnPTenantServicePrincipal</command:noun> </command:details> <maml:description> <maml:para>Disables the current tenant's "SharePoint Online Client" service principal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-PnPTenantServicePrincipal</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Disconnect-PnPOnline</command:name> <maml:description> <maml:para>Disconnects the current connection and clears its token cache.</maml:para> </maml:description> <command:verb>Disconnect</command:verb> <command:noun>PnPOnline</command:noun> </command:details> <maml:description> <maml:para>Disconnects the current connection and optionally clears its token cache. It will require you to build up a new connection again using [Connect-PnPOnline](Connect-PnPOnline.md) in order to use any of the PnP PowerShell cmdlets. You might have to reauthenticate. If instead you simply want to connect to another site collection within the same tenant using the same credentials you used previously, do not use this cmdlet but instead use `Connect-PnPOnline -Url https://tenant.sharepoint.com/sites/othersite` instead without disconnecting. It will try to reuse the existing authentication method and cached credentials.</maml:para> <maml:para>Note that this cmdlet does not support passing in a specific connection to disconnect. If you wish to dispose a specific connection you have set up in a variable using `$variable = Connect-PnPOnline -ReturnConnection`, just dispose that variable using `$variable = $null` and it will be cleared from memory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-PnPOnline</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClearPersistedLogin</maml:name> <maml:description> <maml:para>Clears the entry in the token cache for this connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Disconnect-PnPOnline ```</maml:para> <maml:para>This will clear out all active tokens from the current connection</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Enable-PnPCommSite</command:name> <maml:description> <maml:para>Enables the modern communication site experience on a classic team site.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>PnPCommSite</command:noun> </command:details> <maml:description> <maml:para>This command will enable the modern site experience on a classic team site. The site must be the root site of the site collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPCommSite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>DesignPackageId</maml:name> <maml:description> <maml:para>The id (guid) of the design package to apply: 96c933ac-3698-44c7-9f4a-5fd17d71af9e (Topic = default), 6142d2a0-63a5-4ba0-aede-d9fefca2c767 (Showcase) or f6cc5403-0d63-442e-96c0-285923709ffc (Blank).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>DesignPackageId</maml:name> <maml:description> <maml:para>The id (guid) of the design package to apply: 96c933ac-3698-44c7-9f4a-5fd17d71af9e (Topic = default), 6142d2a0-63a5-4ba0-aede-d9fefca2c767 (Showcase) or f6cc5403-0d63-442e-96c0-285923709ffc (Blank).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPCommSite ```</maml:para> <maml:para>Enables the modern communication site experience on a classic team site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPCommSite -DesignPackageId 6142d2a0-63a5-4ba0-aede-d9fefca2c767 ```</maml:para> <maml:para>Enables the modern communication site experience on a classic team site, allowing to specify the design package to be applied</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Enable-PnPFeature</command:name> <maml:description> <maml:para>Enables a feature</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>PnPFeature</command:noun> </command:details> <maml:description> <maml:para>Allows to enable to feature.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPFeature</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the feature to enable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FeatureScope</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id of the feature to enable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FeatureScope</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe ```</maml:para> <maml:para>This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Force ```</maml:para> <maml:para>This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with force.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPFeature -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Web ```</maml:para> <maml:para>This will enable the feature with the id "99a00f6e-fb81-4dc7-8eac-e09c6f9132fe" with the web scope.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Enable-PnPFlow</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: management.azure.com Enables a specific flow</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>PnPFlow</command:noun> </command:details> <maml:description> <maml:para>This cmdlet enables a specific flow</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPFlow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>Enable the flow as an administrator</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the flow to enable</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerAutomateFlowPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>Enable the flow as an administrator</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the flow to enable</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerAutomateFlowPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPFlow -Identity fba63225-baf9-4d76-86a1-1b42c917a182 ```</maml:para> <maml:para>Enables the specified flow in the default environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPFlow -Environment (Get-PnPPowerPlatformEnvironment -Identity "myenvironment") -Identity fba63225-baf9-4d76-86a1-1b42c917a182 ```</maml:para> <maml:para>Enables the specified flow in the specified environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Enable-PnPPageScheduling</command:name> <maml:description> <maml:para>Enables the modern page schedule feature</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>PnPPageScheduling</command:noun> </command:details> <maml:description> <maml:para>This will enable page publishing scheduling on modern sites</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPPageScheduling</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPPageScheduling ```</maml:para> <maml:para>This will enable page publishing scheduling on the current site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Enable-PnPPowerShellTelemetry</command:name> <maml:description> <maml:para>Enables sending of telemetry data.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>PnPPowerShellTelemetry</command:noun> </command:details> <maml:description> <maml:para>This cmdlet Enables sending of telemetry data.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPPowerShellTelemetry</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Switch parameter which executes the cmdlet and skips the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Enable-PnPPowerShellTelemetry</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Switch parameter which executes the cmdlet and skips the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Switch parameter which executes the cmdlet and skips the confirmation question.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPPowerShellTelemetry ```</maml:para> <maml:para>Enables sending of telemetry data after answering the confirmation question.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPPowerShellTelemetry -Force ```</maml:para> <maml:para>Enables sending of telemetry data skipping the confirmation question.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Enable-PnPPriviledgedIdentityManagement</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph: RoleAssignmentSchedule.ReadWrite.Directory Temporarily enables a Privileged Identity Management role for a user</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>PnPPriviledgedIdentityManagement</command:noun> </command:details> <maml:description> <maml:para>Temporarily enables a Privileged Identity Management role for the provided allowing the user to perform actions that require the role. The role will be enabled starting at the specified date and time and will expire after the specified number of hours. The reason for the elevation of rights can be provided as justification.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPPriviledgedIdentityManagement</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpireInHours</maml:name> <maml:description> <maml:para>Indication of after how many hours the elevation should expire. If omitted, the default value is 1 hour.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">short</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Justification</maml:name> <maml:description> <maml:para>Text to be logged as the reason for the elevation of rights. If omitted, the default value is "Elevated by PnP PowerShell".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PrincipalId</maml:name> <maml:description> <maml:para>The Id of of the principal to elevate. If omitted, the default value is the current user, if the connection has been made using a delegated identity. With an application identity, this parameter is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>The Id, name or instance of a role to elevate the current user to. Use `Get-PnPPriviledgedIdentityManagementRole` to retrieve the available roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PriviledgedIdentityManagementRolePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Date and time at which to start the elevation. If omitted, the default value is the current date and time, meaning the activation will happen immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Enable-PnPPriviledgedIdentityManagement</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpireInHours</maml:name> <maml:description> <maml:para>Indication of after how many hours the elevation should expire. If omitted, the default value is 1 hour.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">short</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Justification</maml:name> <maml:description> <maml:para>Text to be logged as the reason for the elevation of rights. If omitted, the default value is "Elevated by PnP PowerShell".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>The Id, name or instance of a role to elevate the current user to. Use `Get-PnPPriviledgedIdentityManagementRole` to retrieve the available roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PriviledgedIdentityManagementRolePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Date and time at which to start the elevation. If omitted, the default value is the current date and time, meaning the activation will happen immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The Id, username or instance of a user which needs to be elevated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADUserPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Enable-PnPPriviledgedIdentityManagement</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpireInHours</maml:name> <maml:description> <maml:para>Indication of after how many hours the elevation should expire. If omitted, the default value is 1 hour.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">short</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Justification</maml:name> <maml:description> <maml:para>Text to be logged as the reason for the elevation of rights. If omitted, the default value is "Elevated by PnP PowerShell".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Date and time at which to start the elevation. If omitted, the default value is the current date and time, meaning the activation will happen immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExpireInHours</maml:name> <maml:description> <maml:para>Indication of after how many hours the elevation should expire. If omitted, the default value is 1 hour.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">short</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Justification</maml:name> <maml:description> <maml:para>Text to be logged as the reason for the elevation of rights. If omitted, the default value is "Elevated by PnP PowerShell".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PrincipalId</maml:name> <maml:description> <maml:para>The Id of of the principal to elevate. If omitted, the default value is the current user, if the connection has been made using a delegated identity. With an application identity, this parameter is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Role</maml:name> <maml:description> <maml:para>The Id, name or instance of a role to elevate the current user to. Use `Get-PnPPriviledgedIdentityManagementRole` to retrieve the available roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PriviledgedIdentityManagementRolePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartAt</maml:name> <maml:description> <maml:para>Date and time at which to start the elevation. If omitted, the default value is the current date and time, meaning the activation will happen immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The Id, username or instance of a user which needs to be elevated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADUserPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPPriviledgedIdentityManagement -Role "Global Administrator" ```</maml:para> <maml:para>Enables the global administrator role for the current user through Privileged Identity Management starting immediately and expiring in 1 hour</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPPriviledgedIdentityManagement -Role "Global Administrator" -Justification "Just because" ```</maml:para> <maml:para>Enables the global administrator role for the current user through Privileged Identity Management starting immediately and expiring in 1 hour, adding the justification provided to be logged as the reason for the elevation of rights</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPPriviledgedIdentityManagement -Role "Global Administrator" -Justification "Just because" -StartAt (Get-Date).AddHours(2) -ExpireInHours 2 ```</maml:para> <maml:para>Enables the global administrator role for the current user through Privileged Identity Management starting in 2 hours from now and expiring 2 hours thereafter, adding the justification provided to be logged as the reason for the elevation of rights</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPPriviledgedIdentityManagement -Role "Global Administrator" -User "someone@contoso.onmicrosoft.com" ```</maml:para> <maml:para>Enables the global administrator role for the provided user through Privileged Identity Management starting immediately and expiring in 1 hour</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Enable-PnPSiteClassification</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Directory.ReadWrite.All Enables Site Classifications for the tenant</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>PnPSiteClassification</command:noun> </command:details> <maml:description> <maml:para>Allows to enable site classifications for the tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPSiteClassification</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Classifications</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">System.Collections.Generic.List`1[System.String]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DefaultClassification</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UsageGuidelinesUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Classifications</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">System.Collections.Generic.List`1[System.String]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DefaultClassification</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UsageGuidelinesUrl</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPSiteClassification -Classifications "HBI","LBI","Top Secret" -DefaultClassification "LBI" ```</maml:para> <maml:para>Enables Site Classifications for your tenant and provides three classification values. The default value will be set to "LBI"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Enable-PnPSiteClassification -Classifications "HBI","LBI","Top Secret" -UsageGuidelinesUrl https://aka.ms/m365pnp ```</maml:para> <maml:para>Enables Site Classifications for your tenant and provides three classification values. The usage guidelines will be set to the specified URL.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Enable-PnPTenantServicePrincipal</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Enables the current tenant's "SharePoint Online Client" service principal.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>PnPTenantServicePrincipal</command:noun> </command:details> <maml:description> <maml:para>Enables the current tenant's "SharePoint Online Client" service principal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-PnPTenantServicePrincipal</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Export-PnPFlow</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: management.azure.com Exports a Microsoft Power Automate Flow</maml:para> </maml:description> <command:verb>Export</command:verb> <command:noun>PnPFlow</command:noun> </command:details> <maml:description> <maml:para>This cmdlet exports a Microsoft Power Automate Flow either as a json file or as a zip package.</maml:para> <maml:para>Many times exporting a Microsoft Power Automate Flow will not be possible due to various reasons such as connections having gone stale, SharePoint sites referenced no longer existing or other configuration errors in the Flow. To display these errors when trying to export a Flow, provide the -Verbose flag with your export request. If not provided, these errors will silently be ignored.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPFlow</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsZipPackage</maml:name> <maml:description> <maml:para>If specified the flow will be exported as a zip package</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified and the file exported already exists it will be overwritten without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The value of the Name property of a Microsoft Power Automate Flow that you wish to export</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerAutomateFlowPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OutPath</maml:name> <maml:description> <maml:para>Optional file name of the file to export to. If not provided, it will store the ZIP package to the current location from where the cmdlet is being run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageCreatedBy</maml:name> <maml:description> <maml:para>The name of the person to be used as the creator of the exported package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageDescription</maml:name> <maml:description> <maml:para>The description to use in the exported package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageDisplayName</maml:name> <maml:description> <maml:para>The display name to use in the exported package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageSourceEnvironment</maml:name> <maml:description> <maml:para>The name of the source environment from which the exported package was taken</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Export-PnPFlow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The value of the Name property of a Microsoft Power Automate Flow that you wish to export</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerAutomateFlowPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsZipPackage</maml:name> <maml:description> <maml:para>If specified the flow will be exported as a zip package</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified and the file exported already exists it will be overwritten without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The value of the Name property of a Microsoft Power Automate Flow that you wish to export</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerAutomateFlowPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OutPath</maml:name> <maml:description> <maml:para>Optional file name of the file to export to. If not provided, it will store the ZIP package to the current location from where the cmdlet is being run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageCreatedBy</maml:name> <maml:description> <maml:para>The name of the person to be used as the creator of the exported package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageDescription</maml:name> <maml:description> <maml:para>The description to use in the exported package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageDisplayName</maml:name> <maml:description> <maml:para>The display name to use in the exported package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageSourceEnvironment</maml:name> <maml:description> <maml:para>The name of the source environment from which the exported package was taken</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPFlow -Environment (Get-PnPPowerPlatformEnvironment -Identity "myenvironment") -Identity fba63225-baf9-4d76-86a1-1b42c917a182 ```</maml:para> <maml:para>This will export the specified Microsoft Power Automate Flow from the specified Power Platform environment as an output to the current output of PowerShell</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPFlow -Environment (Get-PnPPowerPlatformEnvironment -IsDefault) -Identity fba63225-baf9-4d76-86a1-1b42c917a182 ```</maml:para> <maml:para>This will export the specified Microsoft Power Automate Flow from the default Power Platform environment as an output to the current output of PowerShell</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPowerPlatformEnvironment | foreach { Get-PnPFlow -Environment $_.Name } | foreach { Export-PnPFlow -Environment $_.Properties.EnvironmentDetails.Name -Identity $_ -OutPath "c:\flows\$($_.Name).zip" -AsZipPackage } ```</maml:para> <maml:para>This will export all the Microsoft Power Automate Flows available within the tenant from all users from all the available Power Platform environments as a ZIP package for each of them to a local folder c:\flows</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Export-PnPListToSiteTemplate</command:name> <maml:description> <maml:para>Exports one or more lists to provisioning template</maml:para> </maml:description> <command:verb>Export</command:verb> <command:noun>PnPListToSiteTemplate</command:noun> </command:details> <maml:description> <maml:para>Allows to export one or more lists to provisioning template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPListToSiteTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>Specify the lists to extract, either providing their ID or their Title.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Collections.Generic.List`1[System.String]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OutputInstance</maml:name> <maml:description> <maml:para>Returns the template as an in-memory object, which is an instance of the SiteTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <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" variableLength="true">XMLPnPSchemaVersion</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>Specify the lists to extract, either providing their ID or their Title.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Collections.Generic.List`1[System.String]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OutputInstance</maml:name> <maml:description> <maml:para>Returns the template as an in-memory object, which is an instance of the SiteTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <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" variableLength="true">XMLPnPSchemaVersion</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPListToSiteTemplate -Out template.xml -List "Documents" ```</maml:para> <maml:para>Extracts a list to a new provisioning template including the list specified by title or ID.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPListToSiteTemplate -Out template.pnp -List "Documents","Events" ```</maml:para> <maml:para>Extracts a list to a new provisioning template Office Open XML file, including the lists specified by title or ID.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Export-PnPPage</command:name> <maml:description> <maml:para>Exports a Client Side Page to a PnP Provisioning Template</maml:para> </maml:description> <command:verb>Export</command:verb> <command:noun>PnPPage</command:noun> </command:details> <maml:description> <maml:para>Allows to export a Client Side Page to a PnP Provisioning Template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ExtractConfigurationPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specify to override the question to overwrite a file if it already exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name/identity of the page. This can be a page instance or the filename of the page. I.e. if the page is called MyPage.aspx and is located in the root of the Site Pages library, provide "MyPage" or "MyPage.aspx". If the page is called MyOtherPage.aspx and is located inside a subfolder called HR located in the root of the Site Pages library, provide "HR/MyOtherPage" or "HR/MyOtherPage.aspx</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Out</maml:name> <maml:description> <maml:para>If specified the template will be saved to the file specified with this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OutputInstance</maml:name> <maml:description> <maml:para>Returns the template as an in-memory object, which is an instance of the SiteTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PersistBrandingFiles</maml:name> <maml:description> <maml:para>If specified referenced files will be exported to the current folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ExtractConfigurationPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specify to override the question to overwrite a file if it already exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name/identity of the page. This can be a page instance or the filename of the page. I.e. if the page is called MyPage.aspx and is located in the root of the Site Pages library, provide "MyPage" or "MyPage.aspx". If the page is called MyOtherPage.aspx and is located inside a subfolder called HR located in the root of the Site Pages library, provide "HR/MyOtherPage" or "HR/MyOtherPage.aspx</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ClientSidePagePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Out</maml:name> <maml:description> <maml:para>If specified the template will be saved to the file specified with this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OutputInstance</maml:name> <maml:description> <maml:para>Returns the template as an in-memory object, which is an instance of the SiteTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PersistBrandingFiles</maml:name> <maml:description> <maml:para>If specified referenced files will be exported to the current folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPPage -Identity Home.aspx ```</maml:para> <maml:para>Exports the page 'Home.aspx' to a new PnP Provisioning Template</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPPage -Identity HR/Home.aspx -Out template.pnp ```</maml:para> <maml:para>Exports the page 'Home.aspx' to a new PnP Provisioning Template</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Export-PnPPageMapping</command:name> <maml:description> <maml:para>Get's the built-in mapping files or a custom mapping file for your publishing portal page layouts. These mapping files are used to tailor the page transformation experience.</maml:para> </maml:description> <command:verb>Export</command:verb> <command:noun>PnPPageMapping</command:noun> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPPageMapping</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AnalyzeOOBPageLayouts</maml:name> <maml:description> <maml:para>Set this flag if you also want to analyze the OOB page layouts...typically these are covered via the default mapping, but if you've updated these page layouts you might want to analyze them again</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>BuiltInPageLayoutMapping</maml:name> <maml:description> <maml:para>Exports the builtin pagelayout mapping file (only needed for publishing page transformation)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>BuiltInWebPartMapping</maml:name> <maml:description> <maml:para>Exports the builtin web part mapping file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CustomPageLayoutMapping</maml:name> <maml:description> <maml:para>Analyzes the pagelayouts in the current publishing portal and exports them as a pagelayout mapping file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder to created the mapping file(s) in</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Logging</maml:name> <maml:description> <maml:para>Outputs analyzer logging to the console</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrites existing mapping files</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>PublishingPage</maml:name> <maml:description> <maml:para>The name of the publishing page to export a page layout mapping file for</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AnalyzeOOBPageLayouts</maml:name> <maml:description> <maml:para>Set this flag if you also want to analyze the OOB page layouts...typically these are covered via the default mapping, but if you've updated these page layouts you might want to analyze them again</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>BuiltInPageLayoutMapping</maml:name> <maml:description> <maml:para>Exports the builtin pagelayout mapping file (only needed for publishing page transformation)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>BuiltInWebPartMapping</maml:name> <maml:description> <maml:para>Exports the builtin web part mapping file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CustomPageLayoutMapping</maml:name> <maml:description> <maml:para>Analyzes the pagelayouts in the current publishing portal and exports them as a pagelayout mapping file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder to created the mapping file(s) in</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Logging</maml:name> <maml:description> <maml:para>Outputs analyzer logging to the console</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrites existing mapping files</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>PublishingPage</maml:name> <maml:description> <maml:para>The name of the publishing page to export a page layout mapping file for</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPPageMapping -BuiltInPageLayoutMapping -CustomPageLayoutMapping -Folder c:\\temp -Overwrite ```</maml:para> <maml:para>Exports the built in page layout mapping and analyzes the current site's page layouts and exports these to files in folder c:\temp</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPPageMapping -CustomPageLayoutMapping -PublishingPage mypage.aspx -Folder c:\\temp -Overwrite ```</maml:para> <maml:para>Analyzes the page layout of page mypage.aspx and exports this to a file in folder c:\temp</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPPageMapping -BuiltInWebPartMapping -Folder c:\\temp -Overwrite ```</maml:para> <maml:para>Exports the built in webpart mapping to a file in folder c:\temp. Use this a starting basis if you want to tailer the web part mapping behavior.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Export-PnPPowerApp</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: management.azure.com Exports a Microsoft Power App</maml:para> </maml:description> <command:verb>Export</command:verb> <command:noun>PnPPowerApp</command:noun> </command:details> <maml:description> <maml:para>This cmdlet exports a Microsoft Power App as zip package.</maml:para> <maml:para>Many times exporting a Microsoft Power App will not be possible due to various reasons such as connections having gone stale, SharePoint sites referenced no longer existing or other configuration errors in the App. To display these errors when trying to export a App, provide the -Verbose flag with your export request. If not provided, these errors will silently be ignored.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPPowerApp</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified and the file exported already exists it will be overwritten without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The value of the Name property of a Microsoft Power App that you wish to export</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerAppPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OutPath</maml:name> <maml:description> <maml:para>Optional file name of the file to export to. If not provided, it will store the ZIP package to the current location from where the cmdlet is being run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageCreatedBy</maml:name> <maml:description> <maml:para>The name of the person to be used as the creator of the exported package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageDescription</maml:name> <maml:description> <maml:para>The description to use in the exported package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageDisplayName</maml:name> <maml:description> <maml:para>The display name to use in the exported package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageSourceEnvironment</maml:name> <maml:description> <maml:para>The name of the source environment from which the exported package was taken</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified and the file exported already exists it will be overwritten without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The value of the Name property of a Microsoft Power App that you wish to export</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerAppPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OutPath</maml:name> <maml:description> <maml:para>Optional file name of the file to export to. If not provided, it will store the ZIP package to the current location from where the cmdlet is being run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageCreatedBy</maml:name> <maml:description> <maml:para>The name of the person to be used as the creator of the exported package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageDescription</maml:name> <maml:description> <maml:para>The description to use in the exported package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageDisplayName</maml:name> <maml:description> <maml:para>The display name to use in the exported package</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PackageSourceEnvironment</maml:name> <maml:description> <maml:para>The name of the source environment from which the exported package was taken</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPPowerApp -Identity fba63225-baf9-4d76-86a1-1b42c917a182 -OutPath "C:\Users\user1\Downloads\test_20230408152624.zip" ```</maml:para> <maml:para>This will export the specified Microsoft Power App from the default Power Platform environment as an output to the path specified in the command as -OutPath</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPPowerApp -Environment (Get-PnPPowerPlatformEnvironment -Identity "myenvironment") -Identity fba63225-baf9-4d76-86a1-1b42c917a182 -OutPath "C:\Users\user1\Downloads\test_20230408152624.zip" -PackageDisplayName "MyAppDisplayName" -PackageDescription "Package exported using PnP Powershell" -PackageCreatedBy "Siddharth Vaghasia" -PackageSourceEnvironment "UAT Environment" ``` This will export the specified Microsoft Power App from the specified Power Platform environment with metadata specified</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPowerPlatformEnvironment | foreach { Get-PnPPowerApp -Environment $_.Name } | foreach { Export-PnPPowerApp -Environment $_.Properties.EnvironmentDetails.Name -Identity $_ -OutPath "C:\Users\user1\Downloads\$($_.Name).zip" } ```</maml:para> <maml:para>This will export all the Microsoft Power Apps available within the tenant from all users from all the available Power Platform environments as a ZIP package for each of them to a local folder C:\Users\user1\Downloads</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Export</command:verb> <command:noun>PnPTaxonomy</command:noun> </command:details> <maml:description> <maml:para>Allows to export a taxonomy to either the output or to a file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPTaxonomy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Defaults to Unicode</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeDeprecated</maml:name> <maml:description> <maml:para>If specified will exclude the deprecated taxonomy items in the output. Applicable only if you specify TermSetId or TermStoreName.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeID</maml:name> <maml:description> <maml:para>If specified will include the ids of the taxonomy items in the output. Format: &lt;label&gt;;#&lt;guid&gt;</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>File to export the data to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Defaults to Unicode</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeDeprecated</maml:name> <maml:description> <maml:para>If specified will exclude the deprecated taxonomy items in the output. Applicable only if you specify TermSetId or TermStoreName.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeDeprecated</maml:name> <maml:description> <maml:para>If specified will exclude the deprecated taxonomy items in the output. Applicable only if you specify TermSetId or TermStoreName.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeID</maml:name> <maml:description> <maml:para>If specified will include the ids of the taxonomy items in the output. Format: &lt;label&gt;;#&lt;guid&gt;</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>File to export the data to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPTaxonomy ```</maml:para> <maml:para>Exports the full taxonomy to the standard output</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPTaxonomy -Path c:\output.txt ```</maml:para> <maml:para>Exports the full taxonomy the file output.txt</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPTaxonomy -Path c:\output.txt -TermSetId f6f43025-7242-4f7a-b739-41fa32847254 ```</maml:para> <maml:para>Exports the term set with the specified id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPTaxonomy -Path c:\output.txt -TermSetId f6f43025-7242-4f7a-b739-41fa32847254 -Lcid 1044 ```</maml:para> <maml:para>Exports the term set with the specified id using Norwegian labels</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Export</command:verb> <command:noun>PnPTermGroupToXml</command:noun> </command:details> <maml:description> <maml:para>Allows to export a taxonomy TermGroup to either the output or to an XML file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPTermGroupToXml</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Defaults to Unicode</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or name of the termgroup</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TermGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Out</maml:name> <maml:description> <maml:para>File to export the data to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>Defaults to Unicode</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID or name of the termgroup</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TermGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Out</maml:name> <maml:description> <maml:para>File to export the data to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPTermGroupToXml ```</maml:para> <maml:para>Exports all term groups in the default site collection term store to the standard output</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPTermGroupToXml -Out output.xml ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPTermGroupToXml -Out c:\output.xml -Identity "Test Group" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell $termgroup = Get-PnPTermGroup -Identity Test $termgroup | Export-PnPTermGroupToXml -Out c:\output.xml ```</maml:para> <maml:para>Retrieves a termgroup and subsequently exports that term group to a the file named 'output.xml'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Export-PnPUserInfo</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Export user information from site user information list.</maml:para> </maml:description> <command:verb>Export</command:verb> <command:noun>PnPUserInfo</command:noun> </command:details> <maml:description> <maml:para>Export user information from the site user information list. If the Site parameter has not been specified, the current connect to site will be used.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPUserInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>Specifies the login name of the user to export.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>Specifies the URL of the site collection to which you want to export the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>Specifies the login name of the user to export.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>Specifies the URL of the site collection to which you want to export the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPUserInfo -LoginName user@domain.com -Site "https://yoursite.sharepoint.com/sites/team" ```</maml:para> <maml:para>This exports user data with the email address user@domain.com from the site collection specified.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPUserInfo -LoginName user@domain.com -Site "https://yoursite.sharepoint.com/sites/team" | ConvertTo-Csv | Out-File MyFile.csv ```</maml:para> <maml:para>This exports user data with the email address user@domain.com from the site collection specified, converts it to a CSV format and writes the result to the file MyFile.csv.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Export-PnPUserProfile</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Export user profile data.</maml:para> </maml:description> <command:verb>Export</command:verb> <command:noun>PnPUserProfile</command:noun> </command:details> <maml:description> <maml:para>Export user profile data.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PnPUserProfile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>Specifies the login name of the user to export.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>Specifies the login name of the user to export.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPUserProfile -LoginName user@domain.com ```</maml:para> <maml:para>This exports user profile data with the email address user@domain.com.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Export-PnPUserProfile -LoginName user@domain.com | ConvertTo-Csv | Out-File MyFile.csv ```</maml:para> <maml:para>This exports user profile data with the email address user@domain.com, converts it to a CSV format and writes the result to the file MyFile.csv.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Find</command:verb> <command:noun>PnPFile</command:noun> </command:details> <maml:description> <maml:para>Allows to find a file in the virtual file system of the web.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-PnPFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>Match</maml:name> <maml:description> <maml:para>Wildcard query using * (any number of charactes) and ? (single character)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-PnPFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>Match</maml:name> <maml:description> <maml:para>Wildcard query using * (any number of charactes) and ? (single character)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Find-PnPFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>Match</maml:name> <maml:description> <maml:para>Wildcard query using * (any number of charactes) and ? (single character)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>Match</maml:name> <maml:description> <maml:para>Wildcard query using * (any number of charactes) and ? (single character)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Find-PnPFile -Match *.master ```</maml:para> <maml:para>Will return all masterpages located in the current web.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Find-PnPFile -List "Documents" -Match *.pdf ```</maml:para> <maml:para>Will return all pdf files located in given list.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Find-PnPFile -Folder "Shared Documents/Sub Folder" -Match *.docx ```</maml:para> <maml:para>Will return all docx files located in given folder.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAccessToken</command:name> <maml:description> <maml:para>Returns the current Microsoft Graph OAuth Access token. If a Resource Type Name or Resource URL is specified, it will fetch the access token of the specified resource.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAccessToken</command:noun> </command:details> <maml:description> <maml:para>Returns the OAuth 2.0 Access Token.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAccessToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The scopes to retrieve the token for. Defaults to AllSites.FullControl</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPAccessToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The scopes to retrieve the token for. Defaults to AllSites.FullControl</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPAccessToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The scopes to retrieve the token for. Defaults to AllSites.FullControl</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPAccessToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The scopes to retrieve the token for. Defaults to AllSites.FullControl</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Decoded</maml:name> <maml:description> <maml:para>Returns the details from the access token in a decoded manner</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ListPermissionScopes</maml:name> <maml:description> <maml:para>If specified the current permission scopes on the access token will be listed</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ResourceTypeName</maml:name> <maml:description> <maml:para>Specify the Resource Type for which you want the access token. If not specified, it will by default return a Microsoft Graph access token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ResourceTypeName</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ResourceUrl</maml:name> <maml:description> <maml:para>Specify the Resource URL for which you want the access token, i.e. https://graph.microsoft.com/.default. If not specified, it will by default return a Microsoft Graph access token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>The scopes to retrieve the token for. Defaults to AllSites.FullControl</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAccessToken ```</maml:para> <maml:para>Gets the OAuth 2.0 Access Token to consume the Microsoft Graph API</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAccessToken -Decoded ```</maml:para> <maml:para>Gets the OAuth 2.0 Access Token to consume the Microsoft Graph API and shows the token with its content decoded</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAccessToken -ResourceTypeName SharePoint ```</maml:para> <maml:para>Gets the OAuth 2.0 Access Token to consume the SharePoint APIs and perform CSOM operations.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAccessToken -ResourceTypeName ARM ```</maml:para> <maml:para>Gets the OAuth 2.0 Access Token to consume the Azure Resource Manager APIs and perform related operations. In PnP, you can use them in cmdlets related to Flow and PowerPlatform etc.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAccessToken -ResourceUrl "https://management.azure.com/.default" ```</maml:para> <maml:para>Gets the OAuth 2.0 Access Token to consume the SharePoint APIs and perform CSOM operations.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAccessToken -ListPermissionScopes ```</maml:para> <maml:para>Lists the current permission scopes for the Microsoft Graph API on the access token. Specify -ResourceTypeName to list permissions for other resource types, like SharePoint.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAlert</command:name> <maml:description> <maml:para>Returns registered alerts for a user.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAlert</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve all registered alerts for given users. Using `AllUsers` option will allow to retrieve all alerts in the current site, regardless of the user or list it belongs to.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAlert</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Retrieve alerts with this title. Title comparison is case sensitive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>Retrieves alerts for all users in the current site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Retrieve alerts with this title. Title comparison is case sensitive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User to retrieve the alerts for (User ID, login name or actual User object). Skip this parameter to retrieve the alerts for the current user. Note: Only site owners can retrieve alerts for other users.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">UserPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAlert ```</maml:para> <maml:para>Returns all registered alerts for the current user.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAlert -List "Demo List" ```</maml:para> <maml:para>Returns all alerts registered on the given list for the current user.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAlert -List "Demo List" -User "i:0#.f|membership|Alice@contoso.onmicrosoft.com" ```</maml:para> <maml:para>Returns all alerts registered on the given list for the specified user.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAlert -Title "Demo Alert" ```</maml:para> <maml:para>Returns all alerts with the given title for the current user. Title comparison is case sensitive.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAlert -AllUsers ```</maml:para> <maml:para>Returns all alerts that exist in the current site, regardless of the user or list it belongs to.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAlert -List "Demo List" -AllUsers ```</maml:para> <maml:para>Returns all alerts that exist in the current site for the list "Demo List", regardless of the user it belongs to.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPApp</command:name> <maml:description> <maml:para>Returns the available apps from the app catalog</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPApp</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve available apps from the app catalog. In order to get apps from site collection scoped app catalog set `Scope` option to `Site`.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPApp</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of an app which is available in the app catalog</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AppMetadataPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AppCatalogScope</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specifies the Id of an app which is available in the app catalog</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AppMetadataPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines which app catalog to use. Defaults to Tenant</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AppCatalogScope</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPApp ```</maml:para> <maml:para>This will return all available apps from the tenant app catalog. It will list the installed version in the current site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPApp -Scope Site ```</maml:para> <maml:para>This will return all available apps from the site collection scoped app catalog. It will list the installed version in the current site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPApp -Identity 2646ccc3-6a2b-46ef-9273-81411cbbb60f ```</maml:para> <maml:para>This will retrieve the specific app from the app catalog.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAppErrors</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Returns application errors.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAppErrors</command:noun> </command:details> <maml:description> <maml:para>The Get-PnPAppErrors cmdlet returns application monitoring errors (if available) for the application that is specified by ProductId between StartTimeInUtc in Coordinated Universal Time (UTC) and EndTimeInUtc in UTC.</maml:para> <maml:para>Based on server configuration, errors are available for a limited time. The default is seven days. Older errors are purged. Date time values that are older than 50 years or later than 20 years from today are considered invalid</maml:para> <maml:para>Each error includes the error message, time in UTC that error happened, the site where the error happened, and the error type. Values for error type are as follows: 0 - None, 1 - Install Error, 2 - Upgrade Error, 3 - Runtime Error.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAppErrors</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EndTimeInUtc</maml:name> <maml:description> <maml:para>Specifies the end time in UTC to search for monitoring errors. If not start time is given the current time is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Specifies the application id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartTimeInUtc</maml:name> <maml:description> <maml:para>Specifies the start time in UTC to search for monitoring errors. If not start time is given the default value of 72 hours before the current time is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EndTimeInUtc</maml:name> <maml:description> <maml:para>Specifies the end time in UTC to search for monitoring errors. If not start time is given the current time is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Specifies the application id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartTimeInUtc</maml:name> <maml:description> <maml:para>Specifies the start time in UTC to search for monitoring errors. If not start time is given the default value of 72 hours before the current time is used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAppErrors -ProductId a2681b0c-84fe-41bf-9a8e-d480ab81ba7b ```</maml:para> <maml:para>This example returns a collection of monitoring error messages for the application with the specified id.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAppErrors -ProductId a2681b0c-84fe-41bf-9a8e-d480ab81ba7b -StartTimeInUtc (Get-Date).AddHours(-1).ToUniversalTime() ```</maml:para> <maml:para>This example returns a collection of monitoring error messages for the last hour for the application with the specified id.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAppInfo</command:name> <maml:description> <maml:para>Returns information about installed apps.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAppInfo</command:noun> </command:details> <maml:description> <maml:para>The Get-PnPAppInfo cmdlet gets all the installed applications from an external marketplace or from the App Catalog that contain `Name` in their application names or the installed application with mentioned `ProductId`.</maml:para> <maml:para>The returned collection of installed applications contains Product ID (GUID), Product name and Source.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAppInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Specifies the id of an application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPAppInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the application's name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the application's name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Specifies the id of an application</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAppInfo -Name "Excel Service" ```</maml:para> <maml:para>This will return all installed apps from the external marketplace or from the App Catalog that contain "Excel Service" in the application name.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAppInfo -ProductId 2646ccc3-6a2b-46ef-9273-81411cbbb60f ```</maml:para> <maml:para>This will return the installed application info for the app with the given product id.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAppInfo -Name " " | Sort -Property Name ```</maml:para> <maml:para>Returns all installed apps that have a space in the name and sorts them by name in ascending order.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPApplicationCustomizer</command:name> <maml:description> <maml:para>Returns all SharePoint Framework client side extension application customizers</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPApplicationCustomizer</command:noun> </command:details> <maml:description> <maml:para>Returns all SharePoint Framework client side extension application customizers registered on the current web and/or site</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPApplicationCustomizer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the SharePoint Framework client side extension application customizer to return. Omit to return all SharePoint Framework client side extension application customizer.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned application customizer which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the SharePoint Framework client side extension application customizer, either Web, Site or All to return both (all is the default)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ThrowExceptionIfCustomActionNotFound</maml:name> <maml:description> <maml:para>Switch parameter if an exception should be thrown if the requested SharePoint Framework client side extension application customizer does not exist (true) or if omitted, nothing will be returned in case the SharePoint Framework client side extension application customizer does not exist</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPApplicationCustomizer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest for which existing custom action(s) should be removed</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned application customizer which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the SharePoint Framework client side extension application customizer, either Web, Site or All to return both (all is the default)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ThrowExceptionIfCustomActionNotFound</maml:name> <maml:description> <maml:para>Switch parameter if an exception should be thrown if the requested SharePoint Framework client side extension application customizer does not exist (true) or if omitted, nothing will be returned in case the SharePoint Framework client side extension application customizer does not exist</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSideComponentId</maml:name> <maml:description> <maml:para>The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest for which existing custom action(s) should be removed</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity of the SharePoint Framework client side extension application customizer to return. Omit to return all SharePoint Framework client side extension application customizer.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned application customizer which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope of the SharePoint Framework client side extension application customizer, either Web, Site or All to return both (all is the default)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ThrowExceptionIfCustomActionNotFound</maml:name> <maml:description> <maml:para>Switch parameter if an exception should be thrown if the requested SharePoint Framework client side extension application customizer does not exist (true) or if omitted, nothing will be returned in case the SharePoint Framework client side extension application customizer does not exist</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPApplicationCustomizer ```</maml:para> <maml:para>Returns the custom action representing the SharePoint Framework client side extension registrations registered on the current site collection and web.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPApplicationCustomizer -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 ```</maml:para> <maml:para>Returns the custom action representing the SharePoint Framework client side extension registration with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPApplicationCustomizer -ClientSideComponentId aa66f67e-46c0-4474-8a82-42bf467d07f2 -Scope Web ```</maml:para> <maml:para>Returns the custom action(s) being registered for a SharePoint Framework solution having the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' in its manifest from the current web.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAuditing</command:name> <maml:description> <maml:para>Get the Auditing setting of a site</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAuditing</command:noun> </command:details> <maml:description> <maml:para>Allows to get the auditing setting of the site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAuditing</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAuditing ```</maml:para> <maml:para>Gets the auditing settings of the current site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAuthenticationRealm</command:name> <maml:description> <maml:para>Returns the authentication realm</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAuthenticationRealm</command:noun> </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" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAuthenticationRealm ```</maml:para> <maml:para>This will get the authentication realm for the current connected site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAuthenticationRealm -Url "https://contoso.sharepoint.com" ```</maml:para> <maml:para>This will get the authentication realm for https://contoso.sharepoint.com</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAvailableLanguage</command:name> <maml:description> <maml:para>Returns the available languages on the current web</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAvailableLanguage</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve available languages from the current site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAvailableLanguage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned web language which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned web language which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAvailableLanguage ```</maml:para> <maml:para>This will return the available languages in the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAvailableSensitivityLabel</command:name> <maml:description> <maml:para>Gets the Microsoft Purview sensitivity labels that are available within the tenant</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAvailableSensitivityLabel</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows retrieval of the available Microsoft Purview sensitivity labels in the currently connected tenant. You can retrieve all the labels, a specific label or all the labels available to a specific user. When connected with a delegate token, it will return the Microsoft Purview sensitivity labels for the user you logged on with. When connecting with an application token, it will return all available Microsoft Purview sensitivity labels on the tenant.</maml:para> <maml:para>For retrieval of the available classic Site Classification, use [Get-PnPAvailableSiteClassification](Get-PnPAvailableSiteClassification.md) instead.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAvailableSensitivityLabel</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id of the Microsoft Purview sensitivity label to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The UPN, Id or instance of an Azure AD user for which you would like to retrieve the Microsoft Purview sensitivity labels available to this user</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id of the Microsoft Purview sensitivity label to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The UPN, Id or instance of an Azure AD user for which you would like to retrieve the Microsoft Purview sensitivity labels available to this user</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAvailableSensitivityLabel ```</maml:para> <maml:para>Returns all the Microsoft Purview sensitivity labels that exist on the tenant</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAvailableSensitivityLabel -User johndoe@tenant.onmicrosoft.com ```</maml:para> <maml:para>Returns all Microsoft Purview sensitivity labels which are available to the provided user</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAvailableSensitivityLabel -Identity 47e66706-8627-4979-89f1-fa7afeba2884 ```</maml:para> <maml:para>Returns a specific Microsoft Purview sensitivity label by its id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/informationprotectionpolicy-list-labels</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAvailableSiteClassification</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Directory.Read.All, Directory.ReadWrite.All Returns the available classic Site Classifications for the tenant</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAvailableSiteClassification</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows for retrieving the configuration of the classic site classifications configured within the tenant. For the new Microsoft Purview sensitivity labels, use [Get-PnPAvailableSensitivityLabel](Get-PnPAvailableSensitivityLabel.md) instead.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAvailableSiteClassification</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAvailableSiteClassification ```</maml:para> <maml:para>Returns the currently set site classifications for the tenant.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAzureACSPrincipal</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Returns the list of Azure ACS Principals</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAzureACSPrincipal</command:noun> </command:details> <maml:description> <maml:para>This cmdlet provides insight into the app registrations that have been done over time using AppRegNew.aspx. You could look at it as a (detailed) equivallent of AppPrincipals.aspx. This information can help to get insights into the app registrations that have been done on a tenant and prepare for the Azure Access Control Services (ACS) deprecation that will follow in the future.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureACSPrincipal</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSubsites</maml:name> <maml:description> <maml:para>When specified, it determines whether we should use also search the subsites of the connected site collection and lists the Azure ACS principals.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>When specified, it determines the scope of the Azure ACS principals. Supported values are `List, Web, Site, Tenant , All`. Only with `Tenant` and `All` the `ValidUntil` property will be populated. For the other options it will not, this is by design and makes the cmdlet perform faster.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Enum (AzureACSPrincipalScope)</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSubsites</maml:name> <maml:description> <maml:para>When specified, it determines whether we should use also search the subsites of the connected site collection and lists the Azure ACS principals.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>When specified, it determines the scope of the Azure ACS principals. Supported values are `List, Web, Site, Tenant , All`. Only with `Tenant` and `All` the `ValidUntil` property will be populated. For the other options it will not, this is by design and makes the cmdlet perform faster.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Enum (AzureACSPrincipalScope)</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureACSPrincipal ```</maml:para> <maml:para>Returns the Azure ACS principals</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureACSPrincipal -IncludeSubsites ```</maml:para> <maml:para>Returns the lists of Azure ACS principals installed in your site collection as well as the subsites. The ValidUntil property will not be populated in this scenario.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureACSPrincipal -Scope Tenant ```</maml:para> <maml:para>Returns the lists of Azure ACS principals installed in your Tenant. This a very heavy operation, so it might take some time before we get the results.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureACSPrincipal -Scope All -IncludeSubsites ```</maml:para> <maml:para>Returns the lists of all Azure ACS principals installed in your Tenant including subsites. This a very heavy operation, so it might take some time before we get the results.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAzureADActivityReportDirectoryAudit</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: AuditLog.Read.All and Directory.Read.All Returns the audit logs generated by Azure AD.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAzureADActivityReportDirectoryAudit</command:noun> </command:details> <maml:description> <maml:para>This cmdlet gets the list of audit logs generated by AzureAD. This includes audit logs generated by different services in Azure AD such as user, app, device and group Management, privileged identity management (PIM), access reviews, terms of use, identity protection, password management (self-service and admin password resets) and others.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureADActivityReportDirectoryAudit</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specify the Filter condition for the audit log report.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the ID of the audit log.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specify the Filter condition for the audit log report.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the ID of the audit log.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADActivityReportDirectoryAudit ```</maml:para> <maml:para>Returns all audit logs generated by Azure AD.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADActivityReportDirectoryAudit -Identity "Directory_c3b82411-5445-4620-aace-6a684a252673_02R72_362975819" ```</maml:para> <maml:para>Returns the audit log with specific ID.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADActivityReportDirectoryAudit -Filter "activityDateTime le 2018-01-24" ```</maml:para> <maml:para>Returns the audit logs based on filter condition.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAzureADActivityReportSignIn</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: AuditLog.Read.All and Directory.Read.All Returns the sign in logs generated by Azure AD.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAzureADActivityReportSignIn</command:noun> </command:details> <maml:description> <maml:para>This cmdlet gets the list of sign in logs generated by Azure AD.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureADActivityReportSignIn</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specify the Filter condition for the sign in log report.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the ID of the sign in log.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specify the Filter condition for the sign in log report.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the ID of the sign in log.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADActivityReportSignIn ```</maml:para> <maml:para>Returns all sign logs generated by Azure AD.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADActivityReportSignIn -Identity "da364266-533d-3186-a8b2-44ee1c21af11" ```</maml:para> <maml:para>Returns the sign in log with specific ID.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADActivityReportSignIn -Filter "startsWith(appDisplayName,'Graph')" ```</maml:para> <maml:para>Returns the sign in logs based on filter condition.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAzureADApp</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Application.Read.All Returns Azure AD App registrations.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAzureADApp</command:noun> </command:details> <maml:description> <maml:para>This cmdlets returns all app registrations, a specific one or ones matching a provided filter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureADApp</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the display name, id or app id.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureADAppPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPAzureADApp</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specify the query to pass to Graph API in $filter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specify the query to pass to Graph API in $filter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the display name, id or app id.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureADAppPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADApp ```</maml:para> <maml:para>This returns all Azure AD App registrations.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADApp -Identity MyApp ```</maml:para> <maml:para>This returns the Azure AD App registration with the display name as 'MyApp'.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADApp -Identity 93a9772d-d0af-4ed8-9821-17282b64690e ```</maml:para> <maml:para>This returns the Azure AD App registration with the app id specified or the id specified.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADApp -Filter "startswith(description, 'contoso')" ```</maml:para> <maml:para>This returns the Azure AD App registrations with the description starting with "contoso". This example demonstrates using Advanced Query capabilities (see: https://learn.microsoft.com/graph/aad-advanced-queries?tabs=http#group-properties)</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAzureADAppPermission</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Application.Read.All Returns app permissions for Microsoft SharePoint and Microsoft Graph.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAzureADAppPermission</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns the appid, displayname and permissions set for Microsoft SharePoint and the Microsoft Graph APIs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureADAppPermission</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the display name, id or app id.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureADAppPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the display name, id or app id.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureADAppPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADAppPermission ```</maml:para> <maml:para>Returns all apps with all permissions.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADAppPermission -Identity MyApp ```</maml:para> <maml:para>Returns permissions for the specified app.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADAppPermission -Identity 93a9772d-d0af-4ed8-9821-17282b64690e ```</maml:para> <maml:para>Returns permissions for the specified app.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAzureADAppSitePermission</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Sites.FullControl.All Returns Azure AD App permissions for a site.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAzureADAppSitePermission</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns app permissions for either the current or a given site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureADAppSitePermission</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>Optional url of a site to retrieve the permissions for. Defaults to the current site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPAzureADAppSitePermission</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PermissionId</maml:name> <maml:description> <maml:para>If specified the permission with that id specified will be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>Optional url of a site to retrieve the permissions for. Defaults to the current site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPAzureADAppSitePermission</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AppIdentity</maml:name> <maml:description> <maml:para>You can specify either the Display Name or the AppId to specifically retrieve the permission for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>Optional url of a site to retrieve the permissions for. Defaults to the current site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AppIdentity</maml:name> <maml:description> <maml:para>You can specify either the Display Name or the AppId to specifically retrieve the permission for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PermissionId</maml:name> <maml:description> <maml:para>If specified the permission with that id specified will be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>Optional url of a site to retrieve the permissions for. Defaults to the current site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADAppSitePermission ```</maml:para> <maml:para>Returns the apps that have permissions for the currently connected site. Note that if PermissionId is not specified then the Roles property is not populated. This is a current API limitation.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADAppSitePermission -Site https://contoso.sharepoint.com/sites/projects ```</maml:para> <maml:para>Returns the apps that have permissions for the site specified. Note that you are required to have the SharePoint Administrator role in your tenant to be able to use this command.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADAppSitePermission -PermissionId TowaS50fG1zLnNwLmV4dHwxYxNmI0OTI1 ```</maml:para> <maml:para>Returns the specific app permission details for the given permission id for the current site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADAppSitePermission -AppIdentity "Test App" ```</maml:para> <maml:para>Returns the specific app permission details for the app with the provided name.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADAppSitePermission -AppIdentity "14effc36-dc8b-4f68-8919-f6beb7d847b3" ```</maml:para> <maml:para>Returns the specific app permission details for the app with the provided Id.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAzureADGroup</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Directory.Read.All, Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, GroupMember.Read.All, GroupMember.ReadWrite.All Gets one Azure Active Directory group or a list of Azure Active Directory groups. This can be a security, distribution or Microsoft 365 group.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAzureADGroup</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve a list of Azure Active Directory groups. Those can be a security, distribution or Microsoft 365 group. By specifying `Identity` option it is possible to get a single group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureADGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the Azure Active Directory group. Either specify an id, a display name, email address, or a group object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the Azure Active Directory group. Either specify an id, a display name, email address, or a group object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADGroup ```</maml:para> <maml:para>Retrieves all the Azure Active Directory groups.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADGroup -Identity $groupId ```</maml:para> <maml:para>Retrieves a specific Azure Active Directory group based on its ID.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADGroup -Identity $groupDisplayName ```</maml:para> <maml:para>Retrieves a specific Azure Active Directory group that has the given DisplayName.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADGroup -Identity $groupSiteMailNickName ```</maml:para> <maml:para>Retrieves a specific Azure Active Directory group for which the email address equals the provided mail nickName.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADGroup -Identity $group ```</maml:para> <maml:para>Retrieves a specific Azure Active Directory group based on its group object instance.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAzureADGroupMember</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Directory.Read.All, Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, GroupMember.Read.All, GroupMember.ReadWrite.All, User.Read.All, User.ReadWrite.All Gets members of a particular Entra ID group. This can be a security, distribution or Microsoft 365 group.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAzureADGroupMember</command:noun> </command:details> <maml:description> <maml:para>Allows to list members from given Entra ID group. This can be a security, distribution or Microsoft 365 group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureADGroupMember</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Entra ID group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Transitive</maml:name> <maml:description> <maml:para>If provided, the direct and transitive members (members of groups in the group) of a group will be returned. If not provided, only the members directly assigned to the group will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Entra ID group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Transitive</maml:name> <maml:description> <maml:para>If provided, the direct and transitive members (members of groups in the group) of a group will be returned. If not provided, only the members directly assigned to the group will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADGroupMember -Identity $groupId ```</maml:para> <maml:para>Retrieves all the direct members of a specific Entra ID group based on its ID.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADGroupMember -Identity $group ```</maml:para> <maml:para>Retrieves all the direct members of a specific Entra ID group based on the group's object instance.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADGroupMember -Identity $group -Transitive ```</maml:para> <maml:para>Retrieves all the direct and transitive members (members of groups inside groups) of a specific Entra ID group based on the group's object instance.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAzureADGroupOwner</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Group.Read.All, Group.ReadWrite.All, User.Read.All, User.ReadWrite.All Gets owners of a particular Azure Active Directory group. This can be a security, distribution or Microsoft 365 group.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAzureADGroupOwner</command:noun> </command:details> <maml:description> <maml:para>Allows to list owners from a given Azure Active Directory group. This can be a security, distribution or Microsoft 365 group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureADGroupOwner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the Azure Active Directory group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the Azure Active Directory group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">AzureADGroupPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADGroupOwner -Identity $groupId ```</maml:para> <maml:para>Retrieves all the owners of a specific Azure Active Directory group based on its ID.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADGroupOwner -Identity $group ```</maml:para> <maml:para>Retrieves all the owners of a specific Azure Active Directory group based on the group's object instance.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAzureADServicePrincipal</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Any of Application.Read.All, Application.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All Gets service principal/application registrations in Azure Active Directory.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAzureADServicePrincipal</command:noun> </command:details> <maml:description> <maml:para>Allows retrieval of all service principals/app registrations in Azure Active Directory or a specific service principal/app registration based on the AppId, ObjectId or AppName. This will include both application registrations as well as enterprise applications in Azure Active Directory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureADServicePrincipal</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPAzureADServicePrincipal</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AppId</maml:name> <maml:description> <maml:para>The guid of the application registration its App Id/Client Id to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPAzureADServicePrincipal</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The guid of the application registration its object Id to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPAzureADServicePrincipal</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AppName</maml:name> <maml:description> <maml:para>The name of the application registration to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPAzureADServicePrincipal</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AppId</maml:name> <maml:description> <maml:para>The guid of the application registration its App Id/Client Id to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AppName</maml:name> <maml:description> <maml:para>The name of the application registration to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specify the query to pass to Graph API in $filter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The guid of the application registration its object Id to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipal ```</maml:para> <maml:para>Retrieves all application registrations and enterprise applications from Azure Active Directory.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipal -AppId b8c2a8aa-33a0-43f4-a9d3-fe2851c5293e ```</maml:para> <maml:para>Retrieves the application registration with AppId/ClientId b8c2a8aa-33a0-43f4-a9d3-fe2851c5293e from Azure Active Directory.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipal -ObjectId 06ca9985-367a-41ba-9c44-b2ed88c19aec ```</maml:para> <maml:para>Retrieves the application registration with ObjectId 06ca9985-367a-41ba-9c44-b2ed88c19aec from Azure Active Directory.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipal -AppName "My application" ```</maml:para> <maml:para>Retrieves the application registration with the name "My application" from Azure Active Directory.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipal -Filter "startswith(description, 'contoso')" ```</maml:para> <maml:para>Retrieves the application registration with the description starting with "contoso" from Azure Active Directory. This example demonstrates using Advanced Query capabilities (see: https://learn.microsoft.com/graph/aad-advanced-queries?tabs=http#group-properties).</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/serviceprincipal-get</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAzureADServicePrincipalAssignedAppRole</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Any of Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All Gets the app roles currently assigned to a service principal/application registration in Azure Active Directory.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAzureADServicePrincipalAssignedAppRole</command:noun> </command:details> <maml:description> <maml:para>Allows retrieval of currently assigned app roles of a specific service principals/app registration in Azure Active Directory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureADServicePrincipalAssignedAppRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The object id, name or instance of the application role to retrieve from the currently assigned app roles of the service principal/application registration. If nothing returns, it means this specific role is currently not assigned to the service principal/application registration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ServicePrincipalAppRoleBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Principal</maml:name> <maml:description> <maml:para>The object id, name or instance of the service principal/application registration to list the currently assigned to app roles for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServicePrincipalPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The object id, name or instance of the application role to retrieve from the currently assigned app roles of the service principal/application registration. If nothing returns, it means this specific role is currently not assigned to the service principal/application registration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ServicePrincipalAppRoleBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Principal</maml:name> <maml:description> <maml:para>The object id, name or instance of the service principal/application registration to list the currently assigned to app roles for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServicePrincipalPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipalAssignedAppRole -Principal 797ee8a7-a950-4eb8-945d-7f10cc68a933 ```</maml:para> <maml:para>Retrieves all app roles currently assigned to the application registration with the object Id 797ee8a7-a950-4eb8-945d-7f10cc68a933</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipalAssignedAppRole -Principal "My application" ```</maml:para> <maml:para>Retrieves all app roles currently assigned to the application registration with the name "My application".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipal -AppId fd885e69-86dc-4f3b-851e-ad04920031cf | Get-PnPAzureADServicePrincipalAssignedAppRole ```</maml:para> <maml:para>Retrieves all app roles currently assigned to the application registration with the app Id/Client Id fd885e69-86dc-4f3b-851e-ad04920031cf</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/serviceprincipal-list-approleassignments</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAzureADServicePrincipalAvailableAppRole</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Any of Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All Gets the available app roles available on a service principal/application registration in Azure Active Directory.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAzureADServicePrincipalAvailableAppRole</command:noun> </command:details> <maml:description> <maml:para>Allows retrieval of all available app roles of a specific service principals/app registration in Azure Active Directory. To retrieve the app roles currently assigned to a specific service principal/application registration, use [Get-PnPAzureADServicePrincipalAssignedAppRole](Get-PnPAzureADServicePrincipalAssignedAppRole.md) instead.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureADServicePrincipalAvailableAppRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The object id, name or instance of the application role to retrieve from the service principal/application registration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ServicePrincipalAppRoleBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Principal</maml:name> <maml:description> <maml:para>The object id, name or instance of the service principal/application registration to list the app roles for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServicePrincipalPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The object id, name or instance of the application role to retrieve from the service principal/application registration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ServicePrincipalAppRoleBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Principal</maml:name> <maml:description> <maml:para>The object id, name or instance of the service principal/application registration to list the app roles for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ServicePrincipalPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipalAvailableAppRole -Principal 797ee8a7-a950-4eb8-945d-7f10cc68a933 ```</maml:para> <maml:para>Retrieves all app roles of the application registration with the object Id 797ee8a7-a950-4eb8-945d-7f10cc68a933</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipalAvailableAppRole -Principal "My application" ```</maml:para> <maml:para>Retrieves all app roles of the application registration with the name "My application".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipal -AppId fd885e69-86dc-4f3b-851e-ad04920031cf | Get-PnPAzureADServicePrincipalAvailableAppRole ```</maml:para> <maml:para>Retrieves all app roles of the application registration with the app Id/Client Id fd885e69-86dc-4f3b-851e-ad04920031cf</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADServicePrincipal -BuiltInType MicrosoftGraph | Get-PnPAzureADServicePrincipalAvailableAppRole -Identity "User.ReadWrite.All" ```</maml:para> <maml:para>Retrieves the app role details of the role "User.ReadWrite.All" of the built in Microsoft Graph application registration.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/serviceprincipal-list-approleassignments</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPAzureADUser</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Directory.Read.All, Directory.ReadWrite.All, User.Read.All, User.ReadWrite.All Retrieves users from Azure Active Directory. By default the following properties will be loaded: BusinessPhones, DisplayName, GivenName, JobTitle, Mail, MobilePhone, OfficeLocation, PreferredLanguage, Surname, UserPrincipalName, Id, AccountEnabled</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPAzureADUser</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve a single user or a list of users from Azure Active Directory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureADUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EndIndex</maml:name> <maml:description> <maml:para>Allows defining the last result to return. Useful for i.e. pagination. If omitted, it will return all available users from Azure Active Directory.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Includes a filter to the retrieval of the users. Use OData instructions to construct the filter, i.e. "startswith(DisplayName, 'John')".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Includes a custom sorting instruction to the retrieval of the users. Use OData syntax to construct the orderby, i.e. "DisplayName desc".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Allows providing an array with the property names of specific properties to return. If not provided, the default properties will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartIndex</maml:name> <maml:description> <maml:para>Allows defining the first result to return. Useful for i.e. pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPAzureADUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EndIndex</maml:name> <maml:description> <maml:para>Allows defining the last result to return. Useful for i.e. pagination. If omitted, it will return all available users from Azure Active Directory.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Returns the user with the provided user id.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Allows providing an array with the property names of specific properties to return. If not provided, the default properties will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartIndex</maml:name> <maml:description> <maml:para>Allows defining the first result to return. Useful for i.e. pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPAzureADUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Delta</maml:name> <maml:description> <maml:para>Retrieves all users and provides a SkipToken delta token to allow to query for changes since this run when querying again by adding -DeltaToken to the command.</maml:para> <maml:para>Note that using -Select and -Filter in combination with this parameter is limited. More information on this can be found [here](https://learn.microsoft.com/graph/api/user-delta?view=graph-rest-1.0&tabs=http#odata-query-parameters).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DeltaToken</maml:name> <maml:description> <maml:para>The change token provided during the previous run with -Delta to query for the changes to user objects made in Azure Active Directory since that run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EndIndex</maml:name> <maml:description> <maml:para>Allows defining the last result to return. Useful for i.e. pagination. If omitted, it will return all available users from Azure Active Directory.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Includes a filter to the retrieval of the users. Use OData instructions to construct the filter, i.e. "startswith(DisplayName, 'John')".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Includes a custom sorting instruction to the retrieval of the users. Use OData syntax to construct the orderby, i.e. "DisplayName desc".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Allows providing an array with the property names of specific properties to return. If not provided, the default properties will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartIndex</maml:name> <maml:description> <maml:para>Allows defining the first result to return. Useful for i.e. pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Delta</maml:name> <maml:description> <maml:para>Retrieves all users and provides a SkipToken delta token to allow to query for changes since this run when querying again by adding -DeltaToken to the command.</maml:para> <maml:para>Note that using -Select and -Filter in combination with this parameter is limited. More information on this can be found [here](https://learn.microsoft.com/graph/api/user-delta?view=graph-rest-1.0&tabs=http#odata-query-parameters).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DeltaToken</maml:name> <maml:description> <maml:para>The change token provided during the previous run with -Delta to query for the changes to user objects made in Azure Active Directory since that run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EndIndex</maml:name> <maml:description> <maml:para>Allows defining the last result to return. Useful for i.e. pagination. If omitted, it will return all available users from Azure Active Directory.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Includes a filter to the retrieval of the users. Use OData instructions to construct the filter, i.e. "startswith(DisplayName, 'John')".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Returns the user with the provided user id.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Includes a custom sorting instruction to the retrieval of the users. Use OData syntax to construct the orderby, i.e. "DisplayName desc".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Allows providing an array with the property names of specific properties to return. If not provided, the default properties will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartIndex</maml:name> <maml:description> <maml:para>Allows defining the first result to return. Useful for i.e. pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADUser ```</maml:para> <maml:para>Retrieves all users from Azure Active Directory.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADUser -EndIndex 50 ```</maml:para> <maml:para>Retrieves the first 50 users from Azure Active Directory. Notice that you have no control over who will be in this batch of 50 unless you combine it with the `-Filter` and/or `-OrderBy` parameters.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADUser -Identity 328c7693-5524-44ac-a946-73e02d6b0f98 ```</maml:para> <maml:para>Retrieves the user from Azure Active Directory with the id 328c7693-5524-44ac-a946-73e02d6b0f98</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADUser -Identity john@contoso.com ```</maml:para> <maml:para>Retrieves the user from Azure Active Directory with the user principal name john@contoso.com.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADUser -Identity john@contoso.com -Select "DisplayName","extension_3721d05137db455ad81aa442e3c2d4f9_extensionAttribute1" ```</maml:para> <maml:para>Retrieves only the DisplayName and extensionAttribute1 properties of the user from Azure Active Directory which has the user principal name john@contoso.com.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADUser -Filter "accountEnabled eq false" ```</maml:para> <maml:para>Retrieves all the disabled users from Azure Active Directory.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADUser -Filter "startswith(DisplayName, 'John')" -OrderBy "DisplayName" ```</maml:para> <maml:para>Retrieves all the users from Azure Active Directory of which their DisplayName starts with 'John' and sort the results by the DisplayName.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADUser -Delta ```</maml:para> <maml:para>Retrieves all the users from Azure Active Directory and includes a delta DeltaToken which can be used by providing -DeltaToken `<token>` to query for changes to users in Active Directory since this run.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 9 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADUser -Delta -DeltaToken abcdef ```</maml:para> <maml:para>Retrieves all the users from Azure Active Directory which have had changes since the provided DeltaToken was given out.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 10 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureADUser -StartIndex 10 -EndIndex 20 ```</maml:para> <maml:para>Retrieves the 10th through the 20th user from Azure Active Directory. Notice that you have no control over which users will be in this batch of 10 users.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Get</command:verb> <command:noun>PnPAzureCertificate</command:noun> </command:details> <maml:description> <maml:para>Allows to PEM values and manifest settings for an existing certificate (.pfx) for use when using CSOM via an app-only ADAL application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPAzureCertificate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to the certificate (*.pfx)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the certificate (*.pfx)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to the certificate (*.pfx)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SecureString</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to the certificate (*.pfx)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureCertificate -Path "mycert.pfx" ```</maml:para> <maml:para>This will output PEM values and ADAL app manifest settings for the certificate mycert.pfx.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureCertificate -Path "mycert.pfx" -Password (ConvertTo-SecureString -String "YourPassword" -AsPlainText -Force) ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPAzureCertificate -Path "mycert.cer" | clip ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPBrandCenterConfig</command:name> <maml:description> <maml:para>Returns the Brand Center configuration for the current tenant</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPBrandCenterConfig</command:noun> </command:details> <maml:description> <maml:para>Allows retrieval of the Brand Center configuration for the current tenant. The Brand Center is a centralized location for managing and sharing branding assets, such as logos, colors, and fonts, across Microsoft 365 applications.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPBrandCenterConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPBrandCenterConfig ```</maml:para> <maml:para>Returns the configuration of the Brand Center for the current tenant.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPBrandCenterFontPackage</command:name> <maml:description> <maml:para>Returns the available fonts configured through the Brand Center</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPBrandCenterFontPackage</command:noun> </command:details> <maml:description> <maml:para>Allows retrieval of the available fonts from the various Brand Centers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPBrandCenterFontPackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Store</maml:name> <maml:description> <maml:para>Indicates the source of the fonts to be retrieved. The following values are available: - Tenant: The fonts configured in the tenant Brand Center - Site: The fonts configured in the site collection Brand Center - OutOfBox: The out of box fonts available in the tenant - All: All the fonts available in the tenant, including the ones configured in the tenant and site collection Brand Center and the out of box fonts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Store</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPBrandCenterFontPackage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Unique identifier of the font to be retrieved. This can be its guid, name or a BrandCenterFont object. If not specified, all the available fonts will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BrandCenterFontPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Store</maml:name> <maml:description> <maml:para>Indicates the source of the fonts to be retrieved. The following values are available: - Tenant: The fonts configured in the tenant Brand Center - Site: The fonts configured in the site collection Brand Center - OutOfBox: The out of box fonts available in the tenant - All: All the fonts available in the tenant, including the ones configured in the tenant and site collection Brand Center and the out of box fonts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Store</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Unique identifier of the font to be retrieved. This can be its guid, name or a BrandCenterFont object. If not specified, all the available fonts will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BrandCenterFontPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Store</maml:name> <maml:description> <maml:para>Indicates the source of the fonts to be retrieved. The following values are available: - Tenant: The fonts configured in the tenant Brand Center - Site: The fonts configured in the site collection Brand Center - OutOfBox: The out of box fonts available in the tenant - All: All the fonts available in the tenant, including the ones configured in the tenant and site collection Brand Center and the out of box fonts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Store</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPBrandCenterFontPackage ```</maml:para> <maml:para>Returns all the available fonts</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPBrandCenterFontPackage -Store Site ```</maml:para> <maml:para>Returns the available fonts from the site collection Brand Center</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPBrandCenterFontPackage -Identity "My awesome font" ```</maml:para> <maml:para>Looks up and returns the font with the name "My awesome font" from any of the Brand Centers</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPBrandCenterFontPackage -Identity "2812cbd8-7176-4e45-8911-6a063f89a1f1" ```</maml:para> <maml:para>Looks up and returns the font with the Identity "2812cbd8-7176-4e45-8911-6a063f89a1f1" from any of the Brand Centers</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPBrowserIdleSignout</command:name> <maml:description> <maml:para>Used to retrieve the current configuration values for Idle session sign-out policy.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPBrowserIdleSignout</command:noun> </command:details> <maml:description> <maml:para>Use this cmdlet to retrieve the current configuration values for Idle session sign-out policy, the time at which users are warned and subsequently signed out of Microsoft 365 after a period of browser inactivity in SharePoint and OneDrive.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPBrowserIdleSignout</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPBuiltInDesignPackageVisibility</command:name> <maml:description> <maml:para>Gets the visibility of the available built-in Design Packages.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPBuiltInDesignPackageVisibility</command:noun> </command:details> <maml:description> <maml:para>Use this cmdlet to retrieve the current visibility state of each built-in design package.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPBuiltInDesignPackageVisibility</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DesignPackage</maml:name> <maml:description> <maml:para>Name of the design package, available names are</maml:para> <maml:para>* Topic * Showcase * Blank * TeamSite</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DesignPackageType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>DesignPackage</maml:name> <maml:description> <maml:para>Name of the design package, available names are</maml:para> <maml:para>* Topic * Showcase * Blank * TeamSite</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DesignPackageType</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPBuiltInDesignPackageVisibility -DesignPackage Showcase ```</maml:para> <maml:para>This example retrieves the current visibility state of Showcase built-in design package.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPBuiltInDesignPackageVisibility ```</maml:para> <maml:para>This example retrieves the current visibility state of each built-in design package.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPBuiltInSiteTemplateSettings</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Retrieves the current configuration of the built into SharePoint Online site templates.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPBuiltInSiteTemplateSettings</command:noun> </command:details> <maml:description> <maml:para>Retrieves the current configuration of the built into SharePoint Online site templates.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPBuiltInSiteTemplateSettings</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id of the built into SharePoint Online site template to return configuration settings for. If no configuration has been set previously for a template, no configuration for it will be returned, meaning it will be visible. See https://learn.microsoft.com/powershell/module/sharepoint-online/set-spobuiltinsitetemplatesettings?view=sharepoint-ps#description for the full list of available types.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Template</maml:name> <maml:description> <maml:para>Internal name of the built into SharePoint Online site template to return configuration settings for. If no configuration has been set previously for a template, no configuration for it will be returned, meaning it will be visible.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">BuiltInSiteTemplates</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPBuiltInSiteTemplateSettings ```</maml:para> <maml:para>Returns all available configuration for the all of built into SharePoint Online site templates. If no configuration has been set previously for a template, no configuration for it will be returned, meaning it will be visible.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPBuiltInSiteTemplateSettings -Identity 9522236e-6802-4972-a10d-e98dc74b3344 ```</maml:para> <maml:para>Returns the configuration for the Event Planning built into SharePoint Online site template.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPBuiltInSiteTemplateSettings -Template CrisisManagement ```</maml:para> <maml:para>Returns the configuration for the Crisis Management built into SharePoint Online site template.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPBuiltInSiteTemplateSettings -Identity 00000000-0000-0000-0000-000000000000 ```</maml:para> <maml:para>Returns the default configuration for the built into SharePoint Online site templates.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPBuiltInSiteTemplateSettings -Template All ```</maml:para> <maml:para>Returns the default configuration for the built into SharePoint Online site templates.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPChangeLog</command:name> <maml:description> <maml:para>Returns the changelog for PnP PowerShell</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPChangeLog</command:noun> </command:details> <maml:description> <maml:para>This cmdlets returns what has changed in PnP PowerShell in a specific version in markdown format. It is retrieved dynamically from GitHub.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPChangeLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Nightly</maml:name> <maml:description> <maml:para>Return the changelog for the nightly build</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPChangeLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Return the changelog for a specific version. Be sure to use the correct version number in the format <#>.<#>.<#>, i.e. 2.12.0, otherwise the cmdlet will fail. If omitted, the latest stable version will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Nightly</maml:name> <maml:description> <maml:para>Return the changelog for the nightly build</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Return the changelog for a specific version. Be sure to use the correct version number in the format <#>.<#>.<#>, i.e. 2.12.0, otherwise the cmdlet will fail. If omitted, the latest stable version will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPChangeLog ```</maml:para> <maml:para>Returns the changelog for the latest released stable version.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPChangeLog -Nightly ```</maml:para> <maml:para>Returns the changelog for the current nightly build.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPChangeLog -Version 2.12.0 ```</maml:para> <maml:para>Returns the changelog for the 2.12.0 release.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPCompatibleHubContentTypes</command:name> <maml:description> <maml:para>**Required Permissions** * ViewPages permission on the current web. Returns the list of content types present in content type hub site that can be added to the root web or a list on a target site.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPCompatibleHubContentTypes</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve list of content types present in content type hub site that are possible to be added to the current site or given list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name /> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ListUrl</maml:name> <maml:description> <maml:para>The full URL to the list for which compatible content types need to be fetched, i.e. 'https://contoso.sharepoint.com/web1/Shared Documents'</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The full URL of the web for which compatible content types need to be fetched. In case of a list this should be the url of the web which contains the given list. I.e. 'https://contoso.sharepoint.com/web1'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ListUrl</maml:name> <maml:description> <maml:para>The full URL to the list for which compatible content types need to be fetched, i.e. 'https://contoso.sharepoint.com/web1/Shared Documents'</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The full URL of the web for which compatible content types need to be fetched. In case of a list this should be the url of the web which contains the given list. I.e. 'https://contoso.sharepoint.com/web1'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPCompatibleHubContentTypes -WebUrl 'https://contoso.sharepoint.com/web1' ```</maml:para> <maml:para>This will return the list of content types present in content type hub site that can be added to the root web of the site to which the provided web belongs.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPCompatibleHubContentTypes -WebUrl 'https://contoso.sharepoint.com/web1' -ListUrl 'https://contoso.sharepoint.com/web1/Shared Documents' ```</maml:para> <maml:para>This will return the list of content types present in content type hub site that can be added to the provided list.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPConnection</command:name> <maml:description> <maml:para>Returns the current connection</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPConnection</command:noun> </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:syntaxItem> <maml:name>Get-PnPConnection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by specifying -ReturnConnection on Connect-PnPOnline. If not provided, the connection will be retrieved from the current context.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by specifying -ReturnConnection on Connect-PnPOnline. If not provided, the connection will be retrieved from the current context.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell $ctx = Get-PnPConnection ```</maml:para> <maml:para>This will put the current connection for use with the -Connection parameter on other cmdlets.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPContainer</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Returns one or more Containers in a SharePoint Embedded application.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPContainer</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> <maml:para>### EXAMPLE 1 ```powershell Get-PnPContainer -OwningApplicationId a187e399-0c36-4b98-8f04-1edc167a0996 ```</maml:para> <maml:para>Returns a tabular list of Containers created under the specified SharePoint Embedded application.</maml:para> <maml:para>### EXAMPLE 2 ```powershell Get-PnPContainer -OwningApplicationId a187e399-0c36-4b98-8f04-1edc167a0996 -Identity "b!aBrXSxKDdUKZsaK3Djug6C5rF4MG3pRBomypnjOHiSrjkM_EBk_1S57U3gD7oW-1" ```</maml:para> <maml:para>Returns the properties of the specified container by using the container id</maml:para> <maml:para>### EXAMPLE 3 ```powershell Get-PnPContainer -Identity "bc07d4b8-1c2f-4184-8cc2-a52dfd6fe0c4" -Identity "https://contoso.sharepoint.com/contentstorage/CSP_4bd71a68-8312-4275-99b1-a2b70e3ba0e8" ```</maml:para> <maml:para>Returns the properties of the specified container by using the container url</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPContainer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ArchiveStatus</maml:name> <maml:description> <maml:para>The ArchiveStatus parameter is used to display containers in various stages of archiving. The following states are supported: - Archived: Displays containers in all archived states. - RecentlyArchived: Displays containers in the "Recently archived" state. - FullyArchived: Displays containers in the "Fully archived" state. - Reactivating: Displays containers in the "Reactivating" state. - NotArchived: Displays active containers</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SPContainerArchiveStatusFilterProperties</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify container site url or container id.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ContainerPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OwningApplicationId</maml:name> <maml:description> <maml:para>This parameter specifies the ID of the SharePoint repository services application.</maml:para> <maml:para>To retrieve Containers for the Microsoft Loop app, use OwningApplicationId: a187e399-0c36-4b98-8f04-1edc167a0996. To retrieve Containers for the Microsoft Designer app, use OwningApplicationId: 5e2795e3-ce8c-4cfb-b302-35fe5cd01597</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Paged</maml:name> <maml:description> <maml:para>This parameter can be used when there are more than 5,000 Containers in a given SharePoint Embedded application. Using -Paged will provide a <Paging Token> that will display the next 5,000 Containers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PagingToken</maml:name> <maml:description> <maml:para>Use this parameter to provide the <Paging Token> provided to view the remaining Containers as shown in Example 5. If there are no more Containers to display, the commandlet output will return the message End of Containers view. Otherwise, use the given <Paging Token> to retrieve the next batch of up to 5,000 ontainers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Use this parameter to specify the sort order. The sorting will be done based on Storage used in ascending or descending order.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SortOrder</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ArchiveStatus</maml:name> <maml:description> <maml:para>The ArchiveStatus parameter is used to display containers in various stages of archiving. The following states are supported: - Archived: Displays containers in all archived states. - RecentlyArchived: Displays containers in the "Recently archived" state. - FullyArchived: Displays containers in the "Fully archived" state. - Reactivating: Displays containers in the "Reactivating" state. - NotArchived: Displays active containers</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SPContainerArchiveStatusFilterProperties</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify container site url or container id.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ContainerPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OwningApplicationId</maml:name> <maml:description> <maml:para>This parameter specifies the ID of the SharePoint repository services application.</maml:para> <maml:para>To retrieve Containers for the Microsoft Loop app, use OwningApplicationId: a187e399-0c36-4b98-8f04-1edc167a0996. To retrieve Containers for the Microsoft Designer app, use OwningApplicationId: 5e2795e3-ce8c-4cfb-b302-35fe5cd01597</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Paged</maml:name> <maml:description> <maml:para>This parameter can be used when there are more than 5,000 Containers in a given SharePoint Embedded application. Using -Paged will provide a <Paging Token> that will display the next 5,000 Containers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PagingToken</maml:name> <maml:description> <maml:para>Use this parameter to provide the <Paging Token> provided to view the remaining Containers as shown in Example 5. If there are no more Containers to display, the commandlet output will return the message End of Containers view. Otherwise, use the given <Paging Token> to retrieve the next batch of up to 5,000 ontainers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Use this parameter to specify the sort order. The sorting will be done based on Storage used in ascending or descending order.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SortOrder</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPContainer -OwningApplicationId a187e399-0c36-4b98-8f04-1edc167a0996 ```</maml:para> <maml:para>Returns a tabular list of Containers created under the specified SharePoint Embedded application.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPContainer -OwningApplicationId a187e399-0c36-4b98-8f04-1edc167a0996 -Identity "b!aBrXSxKDdUKZsaK3Djug6C5rF4MG3pRBomypnjOHiSrjkM_EBk_1S57U3gD7oW-1" ```</maml:para> <maml:para>Returns the properties of the specified container by using the container id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPContainer -Identity "bc07d4b8-1c2f-4184-8cc2-a52dfd6fe0c4" -Identity "https://contoso.sharepoint.com/contentstorage/CSP_4bd71a68-8312-4275-99b1-a2b70e3ba0e8" ```</maml:para> <maml:para>Returns the properties of the specified container by using the container url</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPContainerType</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint Embedded Administrator or Global Administrator is required Returns the list of Container Types created for a SharePoint Embedded Application in the tenant.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPContainerType</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> <maml:para>### EXAMPLE 1 ```powershell Get-PnPContainerType ```</maml:para> <maml:para>Returns the list of Container Types created for a SharePoint Embedded application in the tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPContainerType</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPContainerType ```</maml:para> <maml:para>Returns the list of Container Types created for a SharePoint Embedded application in the tenant.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Embedded Container Types</maml:linkText> <command:uri>https://learn.microsoft.com/en-us/sharepoint/dev/embedded/concepts/app-concepts/containertypes</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPContainerTypeConfiguration</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Returns container type configuration of a SharePoint Embedded application.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPContainerTypeConfiguration</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> <maml:para>### EXAMPLE 1 ```powershell Get-PnPContainerTypeConfiguration -Identity a187e399-0c36-4b98-8f04-1edc167a0996 ```</maml:para> <maml:para>Returns a container type configuration data of the application created under the specified SharePoint Embedded application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPContainerTypeConfiguration</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify container type GUID</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ContainerPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify container type GUID</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ContainerPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPContainerTypeConfiguration -Identity a187e399-0c36-4b98-8f04-1edc167a0996 ```</maml:para> <maml:para>Returns a container type configuration data of the application created under the specified SharePoint Embedded application.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPContentType</command:name> <maml:description> <maml:para>Retrieves a content type</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPContentType</command:noun> </command:details> <maml:description> <maml:para>Allows to get single or list of content types from site or list. Use the `Identity` option to specify the exact content type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPContentType</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>List of properties to fetch about the ContentType(s) being returned</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>InSiteHierarchy</maml:name> <maml:description> <maml:para>Search site hierarchy for content types</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>List to query</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ContentTypePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>List of properties to fetch about the ContentType(s) being returned</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>InSiteHierarchy</maml:name> <maml:description> <maml:para>Search site hierarchy for content types</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>List to query</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPContentType ```</maml:para> <maml:para>This will get a listing of all available content types within the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPContentType -InSiteHierarchy ```</maml:para> <maml:para>This will get a listing of all available content types within the site collection</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPContentType -Identity "Project Document" ```</maml:para> <maml:para>This will get the content type with the name "Project Document" within the current context</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPContentType -List "Documents" ```</maml:para> <maml:para>This will get a listing of all available content types within the list "Documents"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPContentType -Includes "SchemaXml" ```</maml:para> <maml:para>This will get a listing of all available content types with the SchemaXml also being returned in the results</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPContentTypePublishingHubUrl</command:name> <maml:description> <maml:para>Returns the url to Content Type Publishing Hub</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPContentTypePublishingHubUrl</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve the url of the Content Type Publishing Hub.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPContentTypePublishingHubUrl</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell $url = Get-PnPContentTypePublishingHubUrl Connect-PnPOnline -Url $url Get-PnPContentType ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPContentTypePublishingStatus</command:name> <maml:description> <maml:para>**Required Permissions** * Fullcontrol permission on the content type hub site. Returns the publishing status of a content type present on content type hub site.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPContentTypePublishingStatus</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve the publishing status of a content type present on content type hub site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPContentTypePublishingStatus</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type object in the content type hub site for which the publishing status needs to be fetched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ContentType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>The content type object in the content type hub site for which the publishing status needs to be fetched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ContentType</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPContentTypePublishingStatus -ContentType 0x0101 ```</maml:para> <maml:para>This will return `True` if content type is published in the content type hub site otherwise it will return `False`.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPContext</command:name> <maml:description> <maml:para>Returns the current SharePoint Online CSOM context</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPContext</command:noun> </command:details> <maml:description> <maml:para>Returns a SharePoint Online Client Side Object Model (CSOM) context</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPContext</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. If not provided, the context of the connection will be retrieved from the current connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. If not provided, the context of the connection will be retrieved from the current connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell $ctx = Get-PnPContext ```</maml:para> <maml:para>This will put the current context in the $ctx variable.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url $siteAurl -Credentials $credentials $ctx = Get-PnPContext Get-PnPList # returns the lists from site specified with $siteAurl Connect-PnPOnline -Url $siteBurl -Credentials $credentials Get-PnPList # returns the lists from the site specified with $siteBurl Set-PnPContext -Context $ctx # switch back to site A Get-PnPList # returns the lists from site A ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPCopilotAdminLimitedMode</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: CopilotSettings-LimitedMode.Read or CopilotSettings-LimitedMode.ReadWrite as delegated permission. Application permission not supported. Returns the current configuration if Copilot in Teams Meetings should respond to sentiment related prompts.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPCopilotAdminLimitedMode</command:noun> </command:details> <maml:description> <maml:para>Returns a setting that controls whether Microsoft 365 Copilot in Teams Meetings users can receive responses to sentiment-related prompts. If this setting is enabled, Copilot in Teams Meetings doesn't respond to sentiment-related prompts and questions asked by the user. If the setting is disabled, Copilot in Teams Meetings responds to sentiment-related prompts and questions asked by the user. Copilot in Teams Meetings currently honors this setting. By default, the setting is disabled.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPCopilotAdminLimitedMode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPCopilotAdminLimitedMode ```</maml:para> <maml:para>This cmdlet will return the current configuration if Copilot in Teams Meetings should respond to sentiment related prompts.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/copilotadminlimitedmode-get</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPCopilotAgent</command:name> <maml:description> <maml:para>Returns the Microsoft Copilot Agents (*.agent) in a site collection.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPCopilotAgent</command:noun> </command:details> <maml:description> <maml:para>This cmdlet iterates through the document libraries in a site and finds the copilot agents in that site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPCopilotAgent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para>The server relative URL to the .agent file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ServerRelativeUrl</maml:name> <maml:description> <maml:para>The server relative URL to the .agent file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPCopilotAgent ```</maml:para> <maml:para>This will return all the Microsoft Copilot agents in a site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPCopilotAgent -ServerRelativeUrl /sites/demo/siteassets/copilots/approved/main.agent ```</maml:para> <maml:para>This will return the specific Microsoft Copilot agent if it exists.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPCustomAction</command:name> <maml:description> <maml:para>Return user custom actions</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPCustomAction</command:noun> </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" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned custom action which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned custom action which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPCustomAction ```</maml:para> <maml:para>Returns all custom actions of the current site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 ```</maml:para> <maml:para>Returns the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPCustomAction -Scope web ```</maml:para> <maml:para>Returns all custom actions for the current web object.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Get</command:verb> <command:noun>PnPDefaultColumnValues</command:noun> </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="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPDeletedContainer</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site The Get-PnPDeletedContainer cmdlet returns a list of all deleted Containers in the Recycle Bin. There is no Identity parameter needed. The list includes the ContainerId, ContainerName, DeletedOn, and CreatedDate. Deleted Containers in the Recycle Bin are permanently deleted after 93 days. Use cmdlet Restore-PnPDeletedContainer to restore a deleted container.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPDeletedContainer</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> <maml:para>### EXAMPLE 1</maml:para> <maml:para>```powershell Get-PnPDeletedContainer ```</maml:para> <maml:para>Returns a list of the ContainerId, ContainerName, and CreatedDate of all deleted Containers in the Recycle Bin.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPDeletedContainer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPDeletedContainer ```</maml:para> <maml:para>Returns a list of the ContainerId, ContainerName, and CreatedDate of all deleted Containers in the Recycle Bin.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPDeletedFlow</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: management.azure.com **Information** * To use this command, you must be a Global or Power Platform administrator. **Note** * A Power Automate flow is soft-deleted when: * It's a non-solution flow. * It's been deleted less than 21 days ago. Returns all soft-deleted Power Automate flows within an environment</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPDeletedFlow</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns Deleted Power Automate Flows meeting the specified criteria.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPDeletedFlow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPDeletedFlow ``` Returns all the deleted flows in the default Power Platform environment belonging to any user</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPowerPlatformEnvironment -Identity "MyOrganization (default)" | Get-PnPDeletedFlow ``` Returns all the deleted flows for a given Power Platform environment belonging to the any user</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPDeletedMicrosoft365Group</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Group.Read.All, Group.ReadWrite.All Gets one deleted Microsoft 365 Group or a list of deleted Microsoft 365 Groups</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPDeletedMicrosoft365Group</command:noun> </command:details> <maml:description> <maml:para>Allows to get list of deleted Microsoft 365 Groups. Use the `Identity` option to specify the exact group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPDeletedMicrosoft365Group</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPDeletedMicrosoft365Group ```</maml:para> <maml:para>Retrieves all deleted Microsoft 365 Groups</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPDeletedMicrosoft365Group -Identity 38b32e13-e900-4d95-b860-fb52bc07ca7f ```</maml:para> <maml:para>Retrieves a specific deleted Microsoft 365 Group based on its ID</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPDeletedTeam</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : Team.ReadBasic.All Gets list of deleted Teams teams.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPDeletedTeam</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve a list of deleted Microsoft Teams teams</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPDeletedTeam</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPDeletedTeam ```</maml:para> <maml:para>Retrieves all the deleted Microsoft Teams teams.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/teamwork-list-deletedteams</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPDiagnostics</command:name> <maml:description> <maml:para>Returns diagnostic information</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPDiagnostics</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns diagnostic information which can help to determine issues with PnP PowerShell</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPDiagnostics</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPDisableSpacesActivation</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Retrieves if SharePoint Spaces is disabled on the entire tenant</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPDisableSpacesActivation</command:noun> </command:details> <maml:description> <maml:para>Retrieves if SharePoint Spaces is disabled on the entire tenant. At this point there is no API yet for retrieving the setting for a specific site, although you can set it for a specific site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPDisableSpacesActivation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPDisableSpacesActivation ```</maml:para> <maml:para>Returns if SharePoint Spaces is disabled on the tenant</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPDocumentSetTemplate</command:name> <maml:description> <maml:para>Retrieves a document set template</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPDocumentSetTemplate</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve a document set template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPDocumentSetTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">DocumentSetPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned document set template which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">DocumentSetPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned document set template which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPDocumentSetTemplate -Identity "Test Document Set" ```</maml:para> <maml:para>This will get the document set template with the name "Test Document Set"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPDocumentSetTemplate -Identity "0x0120D520005DB65D094035A241BAC9AF083F825F3B" ```</maml:para> <maml:para>This will get the document set template with the id "0x0120D520005DB65D094035A241BAC9AF083F825F3B"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPEnterpriseAppInsightsReport</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft SharePoint API: Sites.ReadWrite.All Checks for the status of the generation of the App Insights reports and allows downloading them when they're done.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPEnterpriseAppInsightsReport</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows checking for the status of generated App Insights reports. Only one report can exist for every supported timespan `day, 7 days, 14 days, or 28 days. New requests for reports can be initiated using [Start-PnPEnterpriseAppInsightsReport](Get-PnPEnterpriseAppInsightsReport.md) and will overwrite any existing reports thay may exist.</maml:para> <maml:para>This cmdlet also allows for downloading of the report data when the report is ready.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPEnterpriseAppInsightsReport</maml:name> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPEnterpriseAppInsightsReport</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReportId</maml:name> <maml:description> <maml:para>The amount of days to cover in the report. Valid values are 1, 7, 14, and 28. Default is 1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPEnterpriseAppInsightsReport</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Action</maml:name> <maml:description> <maml:para>When provided with the value `Download`, the cmdlet will return the contents of the report as text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">short</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReportId</maml:name> <maml:description> <maml:para>The amount of days to cover in the report. Valid values are 1, 7, 14, and 28. Default is 1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Action</maml:name> <maml:description> <maml:para>When provided with the value `Download`, the cmdlet will return the contents of the report as text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">short</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReportId</maml:name> <maml:description> <maml:para>The amount of days to cover in the report. Valid values are 1, 7, 14, and 28. Default is 1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPEnterpriseAppInsightsReport ```</maml:para> <maml:para>Will return all reports that have been generated or are still being generated.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPEnterpriseAppInsightsReport -ReportId bed8845f-72ba-43ec-b1f3-844ff6a64f28 ```</maml:para> <maml:para>Will return details on the report with the specified ID.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPEnterpriseAppInsightsReport -ReportId bed8845f-72ba-43ec-b1f3-844ff6a64f28 -Action Download ```</maml:para> <maml:para>Will return the contents of the report with the specified ID as text.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Generate App Insights Reports</maml:linkText> <command:uri>https://learn.microsoft.com/sharepoint/app-insights</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPEventReceiver</command:name> <maml:description> <maml:para>Returns registered event receivers</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPEventReceiver</command:noun> </command:details> <maml:description> <maml:para>Returns all registered or a specific event receiver</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPEventReceiver</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Guid of the event receiver</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">EventReceiverPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned event receiver which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Guid of the event receiver</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">EventReceiverPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned event receiver which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The scope of the EventReceivers to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">EventReceiverScope</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPEventReceiver ```</maml:para> <maml:para>This will return all registered event receivers on the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPEventReceiver -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 ```</maml:para> <maml:para>This will return the event receiver with the provided ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22" from the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPEventReceiver -Identity MyReceiver ```</maml:para> <maml:para>This will return the event receiver with the provided ReceiverName "MyReceiver" from the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPEventReceiver -List "ProjectList" ```</maml:para> <maml:para>This will return all registered event receivers in the provided "ProjectList" list</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPEventReceiver -List "ProjectList" -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPEventReceiver -List "ProjectList" -Identity MyReceiver ```</maml:para> <maml:para>This will return the event receiver in the "ProjectList" list with the provided ReceiverName "MyReceiver"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPEventReceiver -Scope Site ```</maml:para> <maml:para>This will return all the event receivers defined on the current site collection</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPEventReceiver -Scope Web ```</maml:para> <maml:para>This will return all the event receivers defined on the current site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 9 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPEventReceiver -Scope All ```</maml:para> <maml:para>This will return all the event receivers defined on the current site and web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPException</command:name> <maml:description> <maml:para>Returns the last exception that occurred</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPException</command:noun> </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" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Show all exceptions</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Show all exceptions</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPException ```</maml:para> <maml:para>Returns the last exception</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPException -All ```</maml:para> <maml:para>Returns all exceptions that occurred</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPExternalUser</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Returns external users in the tenant.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPExternalUser</command:noun> </command:details> <maml:description> <maml:para>The Get-PnPExternalUser cmdlet returns external users that are located in the tenant based on specified criteria.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPExternalUser </maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>Specifies the maximum number of users to be returned in the collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Integer</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Position</maml:name> <maml:description> <maml:para>Use to specify the zero-based index of the position in the sorted collection of the first result to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Integer</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount</maml:name> <maml:description> <maml:para>Shows users who have accepted an invite but not using the account the invite was sent to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>Specifies the site to retrieve external users for.</maml:para> <maml:para>If no site is specified, the external users for all sites are returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sort results in Ascending or Descending order on the Email property should occur.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SortOrder</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>Specifies the maximum number of users to be returned in the collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Integer</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Position</maml:name> <maml:description> <maml:para>Use to specify the zero-based index of the position in the sorted collection of the first result to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Integer</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount</maml:name> <maml:description> <maml:para>Shows users who have accepted an invite but not using the account the invite was sent to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>Specifies the site to retrieve external users for.</maml:para> <maml:para>If no site is specified, the external users for all sites are returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the sort results in Ascending or Descending order on the Email property should occur.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SortOrder</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPExternalUser -Position 0 -PageSize 2 ```</maml:para> <maml:para>Returns the first two external users in the collection.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPExternalUser -Position 2 -PageSize 2 ```</maml:para> <maml:para>Returns two external users from the third page of the collection.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFeature</command:name> <maml:description> <maml:para>Returns all activated or a specific activated feature</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFeature</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns all activated features or a specific activated feature.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFeature</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">FeaturePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned feature which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FeatureScope</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">FeaturePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned feature which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">FeatureScope</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFeature ```</maml:para> <maml:para>This will return all activated web scoped features</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFeature -Scope Site ```</maml:para> <maml:para>This will return all activated site scoped features</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFeature -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 ```</maml:para> <maml:para>This will return a specific activated web scoped feature</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFeature -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22 -Scope Site ```</maml:para> <maml:para>This will return a specific activated site scoped feature</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPField</command:name> <maml:description> <maml:para>Returns a field from a list or site</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPField</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> <maml:para>### EXAMPLE 1</maml:para> <maml:para>```powershell Get-PnPField ```</maml:para> <maml:para>Gets all the fields from the current site</maml:para> <maml:para>### EXAMPLE 2</maml:para> <maml:para>```powershell Get-PnPField -List "Demo list" -Identity "Speakers" ```</maml:para> <maml:para>Gets the speakers field from the list Demo list</maml:para> <maml:para>### EXAMPLE 3</maml:para> <maml:para>```powershell Get-PnPField -Group "Custom Columns" ```</maml:para> <maml:para>Gets all the fields for the group called Custom Columns for the site currently connected to</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPField</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Filter to the specified group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The field object or name to get</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned field which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>InSiteHierarchy</maml:name> <maml:description> <maml:para>Search site hierarchy for fields</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Filter to the specified group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The field object or name to get</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">FieldPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned field which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>InSiteHierarchy</maml:name> <maml:description> <maml:para>Search site hierarchy for fields</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPField ```</maml:para> <maml:para>Gets all the fields from the current site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPField -List "Demo list" -Identity "Speakers" ```</maml:para> <maml:para>Gets the speakers field from the list Demo list</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPField -Group "Custom Columns" ```</maml:para> <maml:para>Gets all the fields for the group called Custom Columns for the site currently connected to</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFile</command:name> <maml:description> <maml:para>Downloads a file</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFile</command:noun> </command:details> <maml:description> <maml:para>Allows downloading of a file from SharePoint Online. The file contents can either be read directly into memory as text, directly saved to local disk or stored in memory for further processing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsFileObject</maml:name> <maml:description> <maml:para>Retrieve the file contents as a file object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsFile</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filename</maml:name> <maml:description> <maml:para>Name for the local file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsString</maml:name> <maml:description> <maml:para>Retrieve the file contents as a string</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsFile</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsFileObject</maml:name> <maml:description> <maml:para>Retrieve the file contents as a file object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsMemoryStream</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsString</maml:name> <maml:description> <maml:para>Retrieve the file contents as a string</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filename</maml:name> <maml:description> <maml:para>Name for the local file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFile -Url "/sites/project/Shared Documents/Document.docx" ```</maml:para> <maml:para>Retrieves the file and downloads it to the current folder</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFile -Url "https://contoso.sharepoint.com/sites/project/Shared Documents/Document.docx" ```</maml:para> <maml:para>Retrieves the file and downloads it to the current folder</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFile -Url /sites/project/SiteAssets/image.jpg -Path c:\temp -FileName image.jpg -AsFile ```</maml:para> <maml:para>Retrieves the file and downloads it to c:\temp\image.jpg</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsString ```</maml:para> <maml:para>Retrieves the contents of the file as text and outputs its contents to the console</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFile -Url /sites/project/Shared Documents/Folder/Presentation.pptx -AsFileObject ```</maml:para> <maml:para>Retrieves the file and returns it as a File object</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsListItem ```</maml:para> <maml:para>Retrieves the file and returns it as a ListItem object</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFile -Url /personal/john_tenant_onmicrosoft_com/Documents/Sample.xlsx -Path c:\temp -FileName Project.xlsx -AsFile ```</maml:para> <maml:para>Retrieves the file Sample.xlsx by its site relative URL from a OneDrive for Business site and downloads it to c:\temp\Project.xlsx</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFile -Url "/sites/templates/Shared Documents/HR Site.pnp" -AsMemoryStream ```</maml:para> <maml:para>Retrieves the file in memory for further processing</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFileAnalyticsData</command:name> <maml:description> <maml:para>Retrieves analytics data for a file.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFileAnalyticsData</command:noun> </command:details> <maml:description> <maml:para>Retrieves file analytics data within a specific date range.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFileAnalyticsData</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>When specified, it will retrieve all analytics data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AnalyticsAggregationInterval</maml:name> <maml:description> <maml:para>When specified, it will retrieve analytics data with specified aggregation interval. Default is day. Allowed values are `Day`,`Week` and `Month`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>When specified, it will retrieve analytics data ending with specified end date. Should be used along with StartDate parameter</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LastSevenDays</maml:name> <maml:description> <maml:para>When specified, it will retrieve analytics data for the last seven days.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>When specified, it will retrieve analytics data starting from the specified start date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileAnalyticsData -Url "/sites/project/Shared Documents/Document.docx" ```</maml:para> <maml:para>Retrieves all available analytics data for the specified file.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileAnalyticsData -Url "/sites/project/Shared Documents/Document.docx" -LastSevenDays ```</maml:para> <maml:para>Retrieves analytics data for the last seven days of the specified file.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileAnalyticsData -Url "/sites/project/Shared Documents/Document.docx" -StartDate (Get-date).AddDays(-15) -EndDate (Get-date) -AnalyticsAggregationInterval Day ```</maml:para> <maml:para>Retrieves analytics data for the last 15 days of the specified file with aggregation interval as days.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFileCheckedOut</command:name> <maml:description> <maml:para>Returns all files that are currently checked out in a library</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFileCheckedOut</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows to retrieve all files that are currently checked out in a library.</maml:para> <maml:para>Notice: if this cmdlet would return more then 5,000 results, so 5,000 or more checked out files, it will not work and will throw an error. This is unfortunately a limitation of SharePoint Online and not something that can be fixed in the cmdlet. As long as the number of checked out files is below 5,000, this cmdlet will work as expected, even on document libraries that contain more than 5,000 files.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFileCheckedOut</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The list instance, list display name, list url or list id to query for checked out files</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The list instance, list display name, list url or list id to query for checked out files</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileCheckedOut -List "Documents" ```</maml:para> <maml:para>Returns all files that are currently checked out in the "Documents" library.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFileInFolder</command:name> <maml:description> <maml:para>List files in a folder</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFileInFolder</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows listing of all the files in a folder. It can optionally also list all files in the underlying subfolders.</maml:para> <maml:para>When working with a document library containing over 5,000 items in it, you will need to use the -List parameter to specify the document library in order to be able to retrieve the files in it. It will always recursively retrieve all files in the document library. You can also use -Includes to fetch additional properties of the files.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFileInFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeSystemFolders</maml:name> <maml:description> <maml:para>When provided, all files in system folders will be excluded from the output. This parameter is not supported when not providing a folder through -Identity or -FolderSiteRelativeUrl.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>FolderSiteRelativeUrl</maml:name> <maml:description> <maml:para>The site relative URL of the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned files which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Name of the file to retrieve (not case sensitive)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>A switch parameter to include files of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFileInFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeSystemFolders</maml:name> <maml:description> <maml:para>When provided, all files in system folders will be excluded from the output. This parameter is not supported when not providing a folder through -Identity or -FolderSiteRelativeUrl.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A folder instance to the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned files which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Name of the file to retrieve (not case sensitive)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>A switch parameter to include files of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFileInFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeSystemFolders</maml:name> <maml:description> <maml:para>When provided, all files in system folders will be excluded from the output. This parameter is not supported when not providing a folder through -Identity or -FolderSiteRelativeUrl.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned files which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Name of the file to retrieve (not case sensitive)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The document library to retrieve the files from. This parameter is required when working with document libraries containing over 5,000 items.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>A switch parameter to include files of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeSystemFolders</maml:name> <maml:description> <maml:para>When provided, all files in system folders will be excluded from the output. This parameter is not supported when not providing a folder through -Identity or -FolderSiteRelativeUrl.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>FolderSiteRelativeUrl</maml:name> <maml:description> <maml:para>The site relative URL of the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A folder instance to the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned files which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Name of the file to retrieve (not case sensitive)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The document library to retrieve the files from. This parameter is required when working with document libraries containing over 5,000 items.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>A switch parameter to include files of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileInFolder ```</maml:para> <maml:para>Returns all the files in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileInFolder -Recurse ```</maml:para> <maml:para>Returns all the files in the entire site. This will take a while to complete and will cause a lot of calls to be made towards SharePoint Online. Use it wisely.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileInFolder -Identity "Shared Documents" ```</maml:para> <maml:para>Returns the files located in the 'Shared Documents' folder located in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileInFolder -FolderSiteRelativeUrl "SitePages" -ItemName "Default.aspx" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolder -Identity "Shared Documents" | Get-PnPFileInFolder ```</maml:para> <maml:para>Returns all files in the "Shared Documents" folder which is located in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileInFolder -FolderSiteRelativeUrl "SitePages" -Recurse ```</maml:para> <maml:para>Returns all files, including those located in any subfolders, in the folder SitePages which is located in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolder -List "Documents" | Get-PnPFileInFolder -Recurse -ExcludeSystemFolders ```</maml:para> <maml:para>Returns all files, including those located in any subfolders, located in the Documents document library where the files in system folders are excluded</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFileRetentionLabel</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Files.Read.All, Sites.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All Retrieves the retention label information for a file in SharePoint.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFileRetentionLabel</command:noun> </command:details> <maml:description> <maml:para>The Get-PnPFileRetentionLabel cmdlet retrieves the retention label information for a file in SharePoint using Microsoft Graph. It takes a URL as input, decodes it, and specifically encodes the '+' character if it is part of the filename.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFileRetentionLabel</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the file for which to retrieve the retention label information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the file for which to retrieve the retention label information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>This example retrieves the retention label information for the file at the specified URL.</maml:para> <maml:para>```powershell Get-PnPFileRetentionLabel -Url "/sites/Marketing/Shared Documents/Report.pptx" ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFileSensitivityLabel</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Files.Read.All, Sites.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All Retrieves the sensitivity label information for a file in SharePoint.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFileSensitivityLabel</command:noun> </command:details> <maml:description> <maml:para>The Get-PnPFileSensitivityLabel cmdlet retrieves the sensitivity label information for a file in SharePoint using Microsoft Graph. It takes a URL as input, decodes it, and specifically encodes the '+' character if it is part of the filename.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFileSensitivityLabel</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the file for which to retrieve the sensitivity label information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the file for which to retrieve the sensitivity label information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>This example retrieves the sensitivity label information for the file at the specified URL.</maml:para> <maml:para>```powershell Get-PnPFileSensitivityLabel -Url "/sites/Marketing/Shared Documents/Report.pptx" ```</maml:para> <maml:para>This example retrieves the sensitivity label information for the file at the specified URL.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFileSensitivityLabelInfo</command:name> <maml:description> <maml:para>Retrieves the sensitivity label information for a file in SharePoint.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFileSensitivityLabelInfo</command:noun> </command:details> <maml:description> <maml:para>The Get-PnPFileSensitivityLabelInfo cmdlet retrieves the sensitivity label information for a file in SharePoint. It takes a URL as input, decodes it, and specifically encodes the '+' character if it is part of the filename.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFileSensitivityLabelInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the file for which to retrieve the sensitivity label information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the file for which to retrieve the sensitivity label information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>This example retrieves the sensitivity label information for the file at the specified URL.</maml:para> <maml:para>```powershell Get-PnPFileSensitivityLabelInfo -Url "https://contoso.sharepoint.com/sites/Marketing/Shared Documents/Report.pdf" ```</maml:para> <maml:para>This example retrieves the sensitivity label information for the file at the specified URL.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFileSharingLink</command:name> <maml:description> <maml:para>Retrieves sharing links to associated with the file or list item.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFileSharingLink</command:noun> </command:details> <maml:description> <maml:para>Retrieves sharing links for a file or list item.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFileSharingLink</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The server relative path to the file, the unique identifier of the file, the listitem representing the file, or the file object itself to retrieve the sharing links for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FilePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The server relative path to the file, the unique identifier of the file, the listitem representing the file, or the file object itself to retrieve the sharing links for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FilePipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileSharingLink -Identity "/sites/demo/Shared Documents/Test.docx" ```</maml:para> <maml:para>This will fetch sharing links for `Test.docx` file in the `Shared Documents` library based on the server relative url.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileSharingLink -Identity eff4c8ca-7b92-4aa2-9744-855611c6ccf2 ```</maml:para> <maml:para>This will fetch sharing links for the file in the site with the provided unique identifier, regardless of where it is located.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItem -List "Documents" | Get-PnPFileSharingLink ```</maml:para> <maml:para>This will fetch sharing links for all files in the `Documents` library.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItem -List "Documents" -Id 1 | Get-PnPFileSharingLink ```</maml:para> <maml:para>This will fetch sharing links for the file in the `Documents` library with Id 1.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFile -Url "/sites/demo/Shared Documents/Test.docx" | Get-PnPFileSharingLink ```</maml:para> <maml:para>This will fetch sharing links for the passed in file.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileInFolder -Recurse -ExcludeSystemFolders -FolderSiteRelativeUrl "Shared Documents" | Get-PnPFileSharingLink ```</maml:para> <maml:para>This will fetch sharing links for all files in the `Shared Documents` library, including the files in subfolders, excluding the ones in hidden internal system folders.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileInFolder -Recurse -ExcludeSystemFolders -FolderSiteRelativeUrl "Shared Documents" | Get-PnPFileSharingLink | ? ExpirationDateTime -eq $null ```</maml:para> <maml:para>This will fetch sharing links for all files in the `Shared Documents` library, including the files in subfolders, excluding the ones in hidden internal system folders where no expiration has been set on the sharing of the file.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileSharingLink -Identity /sites/demo/Lists/Issue tracker/1_.000 ```</maml:para> <maml:para>This will fetch sharing links for the list item with id `1` from list `Issue Tracker`</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFileVersion</command:name> <maml:description> <maml:para>Retrieves the previous versions of a file. Does not retrieve the current version of the file.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFileVersion</command:noun> </command:details> <maml:description> <maml:para>Retrieves the version history of a file, not including its current version. To get the current version use the MajorVersion and MinorVersion properties returned from Get-PnPFile.</maml:para> <maml:para>It can optionally return the version expiration report, which contains the versions' SnapshotDate (or estimated SnapshotDate if it is not available) and estimated ExpirationDate based on the Automatic Version History Limits.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFileVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UseVersionExpirationReport</maml:name> <maml:description> <maml:para>Returns the file version expiration report. The versions contained in the report has the SnapshotDate (or estimated SnapshotDate if it is not available) and estimated ExpirationDate based on the Automatic Version History Limits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UseVersionExpirationReport</maml:name> <maml:description> <maml:para>Returns the file version expiration report. The versions contained in the report has the SnapshotDate (or estimated SnapshotDate if it is not available) and estimated ExpirationDate based on the Automatic Version History Limits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileVersion -Url Documents/MyDocument.docx ```</maml:para> <maml:para>Retrieves the file version information for the specified file.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileVersion -Url "/sites/marketing/Shared Documents/MyDocument.docx" ```</maml:para> <maml:para>Retrieves the file version information for the specified file by specifying the path to the site and the document library's URL.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFileVersion -Url "/sites/marketing/Shared Documents/MyDocument.docx" -UseVersionExpirationReport ```</maml:para> <maml:para>Retrieves the version expiration report for the specified file.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFlow</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: management.azure.com * Azure Service Management : user_impersonation * Dynamics CRM : user_impersonation * PowerApps Service : User * Link to Required permissions reference : https://pnp.github.io/powershell/articles/determinepermissions.html#help-i-cant-figure-out-which-permissions-i-need Returns Power Automate Flows</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFlow</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns Power Automate Flows meeting the specified criteria.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFlow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>If specified returns all the flows as admin. If not specified only the flows for the current user will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SharingStatus</maml:name> <maml:description> <maml:para>Allows specifying the type of Power Automate Flows that should be returned. Valid values: All, SharedWithMe, Personal.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">FlowSharingStatus</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFlow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>If specified returns all the flows as admin. If not specified only the flows for the current user will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Name/Id of the flow to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>If specified returns all the flows as admin. If not specified only the flows for the current user will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Name/Id of the flow to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SharingStatus</maml:name> <maml:description> <maml:para>Allows specifying the type of Power Automate Flows that should be returned. Valid values: All, SharedWithMe, Personal.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">FlowSharingStatus</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFlow -AsAdmin ``` Returns all the flows in the default Power Platform environment belonging to any user</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPowerPlatformEnvironment -Identity "MyOrganization (default)" | Get-PnPFlow ``` Returns all the flows for a given Power Platform environment belonging to the current user</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFlow -SharingStatus SharedWithMe ``` Returns all the flows which have been shared with the current user in the default Power Platform environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFlow -Identity fba63225-baf9-4d76-86a1-1b42c917a182 ``` Returns a specific flow from the default Power Platform environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFlowOwner</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: management.azure.com Returns the owners of a Power Automate flow</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFlowOwner</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns the Power Automate flow owners for a given Power Automate Flow in a Power Platform environment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFlowOwner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>If specified returns the owners of the given flow as admin. If not specified only the flows for the current user will be targeted, and returns the owners of the targeted flow.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Name, Id or instance of the Power Automate Flow to retrieve the permissions of.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerAutomateFlowPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>If specified returns the owners of the given flow as admin. If not specified only the flows for the current user will be targeted, and returns the owners of the targeted flow.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Name, Id or instance of the Power Automate Flow to retrieve the permissions of.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerAutomateFlowPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFlowOwner -Identity 33f78dac-7e93-45de-ab85-67cad0f6ee30 ``` Returns all the owners of the Power Automate Flow with the provided identifier on the default Power Platform environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFlowOwner -Environment (Get-PnPPowerPlatformEnvironment -Identity "myenvironment") -Identity 33f78dac-7e93-45de-ab85-67cad0f6ee30 ``` Returns all the owners of the Power Automate Flow with the provided identifier on the specified Power Platform environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFlowRun</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: management.azure.com Returns the flows runs for a given flow.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFlowRun</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns the flow runs for a given flow.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFlowRun</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Flow</maml:name> <maml:description> <maml:para>The Name/Id of the flow to retrieve the available runs for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerAutomateFlowPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Name/Id of the flow run to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerAutomateFlowRunPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Flow</maml:name> <maml:description> <maml:para>The Name/Id of the flow to retrieve the available runs for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PowerAutomateFlowPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Name/Id of the flow run to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerAutomateFlowRunPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFlowRun -Flow fba63225-baf9-4d76-86a1-1b42c917a182 ``` This returns all the flow runs for a given flow in the default environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFlowRun -Environment (Get-PnPPowerPlatformEnvironment -Identity "myenvironment") -Flow fba63225-baf9-4d76-86a1-1b42c917a182 -Identity 08585531682024670884771461819CU230 ``` This returns a specific flow run for a given flow in a specific environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell $flowrun = Get-PnPFlowRun -Flow fba63225-baf9-4d76-86a1-1b42c917a182 -Identity 08585531682024670884771461819CU230 $flowrun.Properties.trigger ``` This returns the trigger information of a run of a specific flow located in the default environment as shown below</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Output ---------</maml:title> <maml:introduction> <maml:para>```powershell Name : Recurrence StartTime : 2024-02-02 06:00:00 EndTime : 2024-02-02 06:00:00 ScheduledTime : 2024-02-02 06:00:00 OriginHistoryName : 08584947532854535568834568113CU171 Code : OK Status : Succeeded ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell $flowruns = Get-PnPFlowRun -Environment (Get-PnPPowerPlatformEnvironment -Identity "myenvironment") -Flow fba63225-baf9-4d76-86a1-1b42c917a182 $flowruns.Properties.trigger ``` This returns the trigger information of a run of a specific flow located in the specified environment as shown below</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Output ---------</maml:title> <maml:introduction> <maml:para>```powershell Name : Recurrence StartTime : 2024-02-02 06:00:00 EndTime : 2024-02-02 06:00:00 ScheduledTime : 2024-02-02 06:00:00 OriginHistoryName : 08584947532854535568834568113CU171 Code : OK Status : Succeeded</maml:para> <maml:para>Name : Recurrence StartTime : 2024-02-01 06:00:00 EndTime : 2024-02-01 06:00:00 ScheduledTime : 2024-02-01 06:00:00 OriginHistoryName : 08584948396849679000001446214CU251 Code : OK Status : Succeeded</maml:para> <maml:para>Name : Recurrence StartTime : 2024-01-31 06:00:00 EndTime : 2024-01-31 06:00:00 ScheduledTime : 2024-01-31 06:00:00 OriginHistoryName : 08584949260853628013416159080CU185 Code : OK Status : Succeeded ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFolder</command:name> <maml:description> <maml:para>Returns a folder object</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFolder</command:noun> </command:details> <maml:description> <maml:para>Retrieves the folder instance of the specified location.</maml:para> <maml:para>Use [Resolve-PnPFolder](Resolve-PnPFolder.md) to create the folder if it does not exist. Use [Get-PnPFolderInFolder](Get-PnPFolderInFolder.md) to retrieve subfolders. Use [Get-PnPFileInFolder](Get-PnPFileInFolder.md) to retrieve files in a folder. Use [Get-PnPFolderItem](Get-PnPFolderItem.md) to retrieve files and subfolders.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned folders which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CurrentWebRootFolder</maml:name> <maml:description> <maml:para>If provided, the folder representing the root of the current web will be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned folders which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsListItem</maml:name> <maml:description> <maml:para>Returns the folder as a listitem showing all its properties</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned folders which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsListItem</maml:name> <maml:description> <maml:para>Returns the folder as a listitem showing all its properties</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned folders which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>ListRootFolder</maml:name> <maml:description> <maml:para>Name, ID or instance of a list or document library to retrieve the rootfolder of.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned folders which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>Name, ID or instance of a list or document library to retrieve the folders residing in it for. Please use Get-PnPFolder -ListRootFolder <folder> | Get-PnPFolderInFolder instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsListItem</maml:name> <maml:description> <maml:para>Returns the folder as a listitem showing all its properties</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CurrentWebRootFolder</maml:name> <maml:description> <maml:para>If provided, the folder representing the root of the current web will be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned folders which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>Name, ID or instance of a list or document library to retrieve the folders residing in it for. Please use Get-PnPFolder -ListRootFolder <folder> | Get-PnPFolderInFolder instead.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>ListRootFolder</maml:name> <maml:description> <maml:para>Name, ID or instance of a list or document library to retrieve the rootfolder of.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolder ```</maml:para> <maml:para>Returns all the folders located in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolder -CurrentWebRootFolder ```</maml:para> <maml:para>Returns the folder instance representing the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolder -Url "Shared Documents" ```</maml:para> <maml:para>Returns the folder called 'Shared Documents' which is located in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolder -Url "/sites/demo/Shared Documents" ```</maml:para> <maml:para>Returns the folder called 'Shared Documents' which is located in the root of the site collection located at '/sites/demo'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolder -ListRootFolder "Shared Documents" ```</maml:para> <maml:para>Returns the root folder of the list called 'Shared Documents'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolder -List "Shared Documents" ```</maml:para> <maml:para>Returns the folders inside the root folder of the list called 'Shared Documents'. Please use Get-PnPFolder -ListRootFolder \<folder\> | Get-PnPFolderInFolder instead.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolder -Url "/sites/demo/Shared Documents/Test" -AsListItem ```</maml:para> <maml:para>Returns the folder called 'Test' which is located in the root of the site collection located at '/sites/demo' inside 'Shared Documents' document library as a SharePoint list item.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFolderInFolder</command:name> <maml:description> <maml:para>List subfolders in a folder</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFolderInFolder</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows listing of all the subfolders of a folder. It can optionally also list all folders in the underlying subfolders.</maml:para> <maml:para>When working with a document library containing over 5,000 items in it, you will need to use the -List parameter to specify the document library in order to be able to retrieve the Folders in it. It will always recursively retrieve all folders in the document library. You can also use -Includes to fetch additional properties of the folders.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFolderInFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeSystemFolders</maml:name> <maml:description> <maml:para>When provided, all system folders will be excluded from the output. This parameter is not supported when not providing a folder through -Identity or -FolderSiteRelativeUrl.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>FolderSiteRelativeUrl</maml:name> <maml:description> <maml:para>The site relative URL of the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned files which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Name of the folder to retrieve (not case sensitive)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>A switch parameter to include folders of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFolderInFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeSystemFolders</maml:name> <maml:description> <maml:para>When provided, all system folders will be excluded from the output. This parameter is not supported when not providing a folder through -Identity or -FolderSiteRelativeUrl.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A folder instance to the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned files which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Name of the folder to retrieve (not case sensitive)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>A switch parameter to include folders of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFolderInFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeSystemFolders</maml:name> <maml:description> <maml:para>When provided, all system folders will be excluded from the output. This parameter is not supported when not providing a folder through -Identity or -FolderSiteRelativeUrl.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned files which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Name of the folder to retrieve (not case sensitive)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The document library to retrieve the folders from. This parameter is required when working with document libraries containing over 5,000 items.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>A switch parameter to include folders of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeSystemFolders</maml:name> <maml:description> <maml:para>When provided, all system folders will be excluded from the output. This parameter is not supported when not providing a folder through -Identity or -FolderSiteRelativeUrl.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>FolderSiteRelativeUrl</maml:name> <maml:description> <maml:para>The site relative URL of the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A folder instance to the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned files which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Name of the folder to retrieve (not case sensitive)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The document library to retrieve the folders from. This parameter is required when working with document libraries containing over 5,000 items.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>A switch parameter to include folders of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderInFolder ```</maml:para> <maml:para>Returns all the folders in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderInFolder -Recurse ```</maml:para> <maml:para>Returns all the folders in the entire site. This will take a while to complete and will cause a lot of calls to be made towards SharePoint Online. Use it wisely.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderInFolder -Identity "Shared Documents" ```</maml:para> <maml:para>Returns the folders located in the 'Shared Documents' folder located in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderInFolder -Identity "Shared Documents" -ExcludeSystemFolders ```</maml:para> <maml:para>Returns the folders located in the 'Shared Documents' folder located in the root of the current web which are not hidden system folders</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderInFolder -FolderSiteRelativeUrl "Shared Documents" -ItemName "Templates" ```</maml:para> <maml:para>Returns the folder 'Template' which is located in the folder 'Shared Documents' which is located in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolder -Identity "Shared Documents" | Get-PnPFolderInFolder ```</maml:para> <maml:para>Returns all folders in the "Shared Documents" folder which is located in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderInFolder -FolderSiteRelativeUrl "SitePages" -Recurse ```</maml:para> <maml:para>Returns all folders, including those located in any subfolders, in the folder SitePages which is located in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFolderItem</command:name> <maml:description> <maml:para>List files and/or subfolders in a folder</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFolderItem</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows listing of all the content in a folder. It can be used to list all files and folders in a folder and optionally all its subfolders.</maml:para> <maml:para>When working with a document library containing over 5,000 items in it, you will need to use the -List parameter to specify the document library in order to be able to retrieve the Files and Folders in it. It will always recursively retrieve all files and folders in the document library. It is still possible to use -ItemType to restrict the results to only files or folders. You can also use -Includes to fetch additional properties of the files and folders. Start the property name with "File." or "Folder." followed by the property name of the file or folder. For example, to include the file version history report, pass in -Includes "File.VersionExpirationReport".</maml:para> <maml:para>Use [Get-PnPFileInFolder](Get-PnPFileInFolder.md) to retrieve only files and [Get-PnPFolderInFolder](Get-PnPFolderInFolder.md) to retrieve only folders allowing additional properties of the returned items to be requested.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFolderItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>FolderSiteRelativeUrl</maml:name> <maml:description> <maml:para>The site relative URL of the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Name of the item to retrieve (not case sensitive)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>A switch parameter to include contents of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFolderItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Name of the item to retrieve (not case sensitive)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>A switch parameter to include contents of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFolderItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Name of the item to retrieve (not case sensitive)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The document library to retrieve the files and folders from. This parameter is required when working with document libraries containing over 5,000 items.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>A switch parameter to include contents of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>FolderSiteRelativeUrl</maml:name> <maml:description> <maml:para>The site relative URL of the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A folder instance to the folder to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ItemName</maml:name> <maml:description> <maml:para>Name of the item to retrieve (not case sensitive)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The document library to retrieve the files and folders from. This parameter is required when working with document libraries containing over 5,000 items.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>A switch parameter to include contents of all subfolders in the specified folder</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderItem ```</maml:para> <maml:para>Returns all the files and folders in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderItem -Recurse ```</maml:para> <maml:para>Returns all the files and folders in the entire site. This will take a while to complete and will cause a lot of calls to be made towards SharePoint Online. Use it wisely.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderItem -Identity "Shared Documents" ```</maml:para> <maml:para>Returns the files and folders located in the 'Shared Documents' folder located in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -ItemName "Default.aspx" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -ItemType Folder ```</maml:para> <maml:para>Returns all subfolders of the folder SitePages which is located in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolder -Url "Shared Documents" | Get-PnPFolderItem -ItemType File ```</maml:para> <maml:para>Returns all files in the "Shared Documents" folder which is located in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -Recursive ```</maml:para> <maml:para>Returns all files and folders, including contents of any subfolders, in the folder SitePages which is located in the root of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFolderSharingLink</command:name> <maml:description> <maml:para>Retrieves sharing links to associated with the folder.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFolderSharingLink</command:noun> </command:details> <maml:description> <maml:para>Retrieves sharing links for a folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFolderSharingLink</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder in the site</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderSharingLink -Folder "/sites/demo/Shared Documents/Test" ```</maml:para> <maml:para>This will fetch sharing links for `Test` folder in the `Shared Documents` library.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFolderStorageMetric</command:name> <maml:description> <maml:para>Allows retrieval of storage metrics for a folder in SharePoint Online</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFolderStorageMetric</command:noun> </command:details> <maml:description> <maml:para>Allows retrieval of storage metrics for a folder in SharePoint Online. It will reveal the true storage usage, similar to what will be shown through storman.aspx, the date and time the folder was last modified and the amount of files inside the folder.</maml:para> <maml:para>Please note that there is a delay of typically just a few minutes between making changes to files on a site and this cmdlet returning updated values.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFolderStorageMetric</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FolderSiteRelativeUrl</maml:name> <maml:description> <maml:para>The path to the folder to query for its storage consumption, relative to the SharePoint Online site to which the connection has been made, i.e. "Shared Documents\Subfolder"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFolderStorageMetric</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id, name or instance of a folder to query for its storage consumption</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPFolderStorageMetric</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>Id, name or instance of a list to query for its storage consumption</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FolderSiteRelativeUrl</maml:name> <maml:description> <maml:para>The path to the folder to query for its storage consumption, relative to the SharePoint Online site to which the connection has been made, i.e. "Shared Documents\Subfolder"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id, name or instance of a folder to query for its storage consumption</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">FolderPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>Id, name or instance of a list to query for its storage consumption</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderStorageMetric ``` Retrieves the storage metrics of the current site/web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderStorageMetric -List "Documents" ``` Retrieves the storage metrics of the specified document library</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFolderStorageMetric -FolderSiteRelativeUrl "Shared Documents" ``` Retrieves the storage metrics of the folder using the server-relative Url</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell $folder = Get-PnPFolder -Url "Shared Documents" Get-PnPFolderStorageMetric -Identity $folder ```</maml:para> <maml:para>Retrieves the storage metrics of the folder using the identity parameter</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPFooter</command:name> <maml:description> <maml:para>Gets the configuration regarding the footer of the current web</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPFooter</command:noun> </command:details> <maml:description> <maml:para>Allows the current configuration of the footer in the current web to be retrieved. The footer currently only works on Modern Communication sites.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPFooter</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPFooter ```</maml:para> <maml:para>Returns the current footer configuration of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPGraphSubscription</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : Subscription.Read.All Gets subscriptions from Microsoft Graph.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPGraphSubscription</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> <maml:para>### EXAMPLE 1 ```powershell Get-PnPGraphSubscription ```</maml:para> <maml:para>Retrieves all subscriptions from Microsoft Graph</maml:para> <maml:para>### EXAMPLE 2 ```powershell Get-PnPGraphSubscription -Identity 328c7693-5524-44ac-a946-73e02d6b0f98 ```</maml:para> <maml:para>Retrieves the subscription from Microsoft Graph with the id 328c7693-5524-44ac-a946-73e02d6b0f98</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPGraphSubscription</maml:name> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPGraphSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Returns the subscription with the provided subscription id</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Returns the subscription with the provided subscription id</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPGraphSubscription ```</maml:para> <maml:para>Retrieves all subscriptions from Microsoft Graph</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPGraphSubscription -Identity 328c7693-5524-44ac-a946-73e02d6b0f98 ```</maml:para> <maml:para>Retrieves the subscription from Microsoft Graph with the id 328c7693-5524-44ac-a946-73e02d6b0f98</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPGroup</command:name> <maml:description> <maml:para>Returns a specific SharePoint group or all SharePoint groups in the current site</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPGroup</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> <maml:para>### EXAMPLE 1 ```powershell Get-PnPGroup ```</maml:para> <maml:para>Returns all SharePoint groups in the current site</maml:para> <maml:para>### EXAMPLE 2 ```powershell Get-PnPGroup -Identity 'My Site Users' ```</maml:para> <maml:para>This will return the group called 'My Site Users' if available in the current site. The name is case sensitive, so a group called 'My site users' would not be found.</maml:para> <maml:para>### EXAMPLE 3 ```powershell Get-PnPGroup -AssociatedMemberGroup ```</maml:para> <maml:para>This will return the current members group for the site</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned SharePoint security group which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get a specific group by its name or id. The name case sensitive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned SharePoint security group which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssociatedMemberGroup</maml:name> <maml:description> <maml:para>Retrieve the associated member group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned SharePoint security group which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssociatedVisitorGroup</maml:name> <maml:description> <maml:para>Retrieve the associated visitor group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned SharePoint security group which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssociatedOwnerGroup</maml:name> <maml:description> <maml:para>Retrieve the associated owner group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned SharePoint security group which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssociatedMemberGroup</maml:name> <maml:description> <maml:para>Retrieve the associated member group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssociatedOwnerGroup</maml:name> <maml:description> <maml:para>Retrieve the associated owner group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AssociatedVisitorGroup</maml:name> <maml:description> <maml:para>Retrieve the associated visitor group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Get a specific group by its name or id. The name case sensitive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned SharePoint security group which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPGroup ```</maml:para> <maml:para>Returns all SharePoint groups in the current site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPGroup -Identity 'My Site Users' ```</maml:para> <maml:para>This will return the group called 'My Site Users' if available in the current site. The name is case sensitive, so a group called 'My site users' would not be found.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPGroup -AssociatedMemberGroup ```</maml:para> <maml:para>This will return the current members group for the site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPGroupMember</command:name> <maml:description> <maml:para>Retrieves all members of a SharePoint group</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPGroupMember</command:noun> </command:details> <maml:description> <maml:para>This command will return all the users (or a specific user) that are members of the provided SharePoint group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPGroupMember</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</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" variableLength="true">GroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</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" variableLength="true">GroupPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPGroupMember -Group "Marketing Site Members" ```</maml:para> <maml:para>Returns all the users that are a member of the group "Marketing Site Members" in the current site collection</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPGroupMember -Group "Marketing Site Members" -User "manager@domain.com" ```</maml:para> <maml:para>Will return a user if the user "manager@domain.com" is a member of the specified SharePoint group</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPGroup | Get-PnPGroupMember ```</maml:para> <maml:para>Returns all the users that are a member of any of the groups in the current site collection</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPGroup | ? Title -Like 'Marketing*' | Get-PnPGroupMember ```</maml:para> <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 site collection</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPGroupPermissions</command:name> <maml:description> <maml:para>Returns the permissions for a specific SharePoint group</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPGroupPermissions</command:noun> </command:details> <maml:description> <maml:para>This command will return the permissions of a specific SharePoint group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPGroupPermissions</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>SharePoint group name, id or instance to return the permissions for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">GroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>SharePoint group name, id or instance to return the permissions for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">GroupPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPGroupPermissions -Identity 'My Site Members' ```</maml:para> <maml:para>Returns the permissions for the SharePoint group with the name 'My Site Members'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPHideDefaultThemes</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Returns if the default / OOTB themes should be visible to users or not.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPHideDefaultThemes</command:noun> </command:details> <maml:description> <maml:para>Returns if the default themes are visible. Use Set-PnPHideDefaultThemes to change this value.</maml:para> <maml:para>You must be a SharePoint Online global administrator to run the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPHideDefaultThemes</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPHideDefaultThemes ```</maml:para> <maml:para>This example returns the current setting if the default themes should be visible</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPHomePage</command:name> <maml:description> <maml:para>Return the homepage</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPHomePage</command:noun> </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" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPHomePage ```</maml:para> <maml:para>Will return the URL of the home page of the web.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPHomeSite</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Returns the SharePoint home sites for your tenant</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPHomeSite</command:noun> </command:details> <maml:description> <maml:para>This cmdlet will return the SharePoint Home sites for your tenant. Depending on which parameters you provide, you will get returned either the default first Home Site URL or details on all the Home Sites that have been configured for your tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPHomeSite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsVivaConnectionsDefaultStartForCompanyPortalSiteEnabled</maml:name> <maml:description> <maml:para>When provided, it retrieves whether Viva Connections landing experience is set to the SharePoint home site.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPHomeSite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>When provided, it returns detailed information on all the home sites configured on your tenant</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>When provided, it returns detailed information on all the home sites configured on your tenant</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsVivaConnectionsDefaultStartForCompanyPortalSiteEnabled</maml:name> <maml:description> <maml:para>When provided, it retrieves whether Viva Connections landing experience is set to the SharePoint home site.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPHomeSite ```</maml:para> <maml:para>Returns the URL of the first home site for your tenant</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPHomeSite -IsVivaConnectionsDefaultStartForCompanyPortalSiteEnabled ```</maml:para> <maml:para>Returns whether Viva Connections landing experience is set to the SharePoint home site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPHomeSite -Detailed ```</maml:para> <maml:para>Returns detailed information on all the home sites that have been configured for your tenant</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPHubSite</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Retrieve all or a specific hubsite.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPHubSite</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> <maml:para>### EXAMPLE 1 ```powershell Get-PnPHubSite ```</maml:para> <maml:para>Returns all hubsite properties</maml:para> <maml:para>### EXAMPLE 2 ```powershell Get-PnPHubSite -Identity "https://contoso.sharepoint.com/sites/myhubsite" ```</maml:para> <maml:para>Returns the properties of the specified hubsite by using the hubsite url</maml:para> <maml:para>### EXAMPLE 3 ```powershell Get-PnPHubSite -Identity "bc07d4b8-1c2f-4184-8cc2-a52dfd6fe0c4" ```</maml:para> <maml:para>Returns the properties of the specified hubsite by using the hubsite site id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPHubSite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify hub site url or site id</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">HubSitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify hub site url or site id</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">HubSitePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPHubSite ```</maml:para> <maml:para>Returns all hubsite properties</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPHubSite -Identity "https://contoso.sharepoint.com/sites/myhubsite" ```</maml:para> <maml:para>Returns the properties of the specified hubsite by using the hubsite url</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPHubSite -Identity "bc07d4b8-1c2f-4184-8cc2-a52dfd6fe0c4" ```</maml:para> <maml:para>Returns the properties of the specified hubsite by using the hubsite site id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPHubSiteChild</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Retrieves all sites associated to a specific hub site</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPHubSiteChild</command:noun> </command:details> <maml:description> <maml:para>Retrieves all sites associated to a specific hub site</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPHubSiteChild</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The URL, Id or instance of the hubsite for which to receive the sites referring to it. If not provided, the currently connected to site will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">HubSitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The URL, Id or instance of the hubsite for which to receive the sites referring to it. If not provided, the currently connected to site will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">HubSitePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPHubSiteChild ```</maml:para> <maml:para>Returns the sites which are associated to the currently connected to hub site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPHubSiteChild -Identity "https://contoso.sharepoint.com/sites/myhubsite" ```</maml:para> <maml:para>Returns the sites which are associated with the provided hub site as their hub site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPHubSite | Get-PnPHubSiteChild ```</maml:para> <maml:para>Returns all sites that are associated to a hub site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Get</command:verb> <command:noun>PnPIndexedPropertyKeys</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPIndexedPropertyKeys</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Get</command:verb> <command:noun>PnPInPlaceRecordsManagement</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> <maml:para>### EXAMPLE 1 ```powershell Get-PnPInPlaceRecordsManagement ```</maml:para> <maml:para>Returns if $true if in place records management is active</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPInPlaceRecordsManagement</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPInPlaceRecordsManagement ```</maml:para> <maml:para>Returns if $true if in place records management is active</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPIsSiteAliasAvailable</command:name> <maml:description> <maml:para>Validates if a certain alias is still available to be used to create a new site collection for. If it is not, it will propose an alternative alias and URL which is still available.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPIsSiteAliasAvailable</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> <maml:para>### EXAMPLE 1 ```powershell Get-PnPIsSiteAliasAvailable -Identity "HR" ```</maml:para> <maml:para>Validates if the alias "HR" is still available to be used</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPIsSiteAliasAvailable</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Alias you want to check for if it is still available to create a new site collection for</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Alias you want to check for if it is still available to create a new site collection for</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPIsSiteAliasAvailable -Identity "HR" ```</maml:para> <maml:para>Validates if the alias "HR" is still available to be used</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Get</command:verb> <command:noun>PnPJavaScriptLink</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> <maml:para>### EXAMPLE 1 ```powershell Get-PnPJavaScriptLink ```</maml:para> <maml:para>Returns all web scoped JavaScript links</maml:para> <maml:para>### EXAMPLE 2 ```powershell Get-PnPJavaScriptLink -Scope All ```</maml:para> <maml:para>Returns all web and site scoped JavaScript links</maml:para> <maml:para>### EXAMPLE 3 ```powershell Get-PnPJavaScriptLink -Scope Web ```</maml:para> <maml:para>Returns all Web scoped JavaScript links</maml:para> <maml:para>### EXAMPLE 4 ```powershell Get-PnPJavaScriptLink -Scope Site ```</maml:para> <maml:para>Returns all Site scoped JavaScript links</maml:para> <maml:para>### EXAMPLE 5 ```powershell Get-PnPJavaScriptLink -Name Test ```</maml:para> <maml:para>Returns the web scoped JavaScript link named Test</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPJavaScriptLink</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">CustomActionScope</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPJavaScriptLink ```</maml:para> <maml:para>Returns all web scoped JavaScript links</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPJavaScriptLink -Scope All ```</maml:para> <maml:para>Returns all web and site scoped JavaScript links</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPJavaScriptLink -Scope Web ```</maml:para> <maml:para>Returns all Web scoped JavaScript links</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPJavaScriptLink -Scope Site ```</maml:para> <maml:para>Returns all Site scoped JavaScript links</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPJavaScriptLink -Name Test ```</maml:para> <maml:para>Returns the web scoped JavaScript link named Test</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPKnowledgeHubSite</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Gets the Knowledge Hub Site URL for your tenant</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPKnowledgeHubSite</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> <maml:para>### EXAMPLE 1 ```powershell Get-PnPKnowledgeHubSite ```</maml:para> <maml:para>Returns the Knowledge Hub Site Url for your tenant</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPKnowledgeHubSite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPKnowledgeHubSite ```</maml:para> <maml:para>Returns the Knowledge Hub Site Url for your tenant</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPLargeListOperationStatus</command:name> <maml:description> <maml:para>Get the status of a large list operation. Currently supports large list removal operation.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPLargeListOperationStatus</command:noun> </command:details> <maml:description> <maml:para>Allows to get the status of a large list operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPLargeListOperationStatus</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>ID of the list. Retrieve the value for this parameter from the output of the large list operation command. It can be retrieved as: `Remove-PnPList -Identity "Contoso" -Recycle -LargeList`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>OperationId of the large list operation. Retrieve the value for this parameter from the output of the large list operation command which can be used as: `Remove-PnPList -Identity "Contoso" -Recycle -LargeList`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>ID of the list. Retrieve the value for this parameter from the output of the large list operation command. It can be retrieved as: `Remove-PnPList -Identity "Contoso" -Recycle -LargeList`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>OperationId of the large list operation. Retrieve the value for this parameter from the output of the large list operation command which can be used as: `Remove-PnPList -Identity "Contoso" -Recycle -LargeList`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPLargeListOperationStatus -Identity 9ea5d197-2227-4156-9ae1-725d74dc029d -OperationId 924e6a34-5c90-4d0d-8083-2efc6d1cf481 ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPLibraryFileVersionBatchDeleteJobStatus</command:name> <maml:description> <maml:para>Get the progress of deleting existing file versions on the document library.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPLibraryFileVersionBatchDeleteJobStatus</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows retrieval of the progress of deleting existing file versions on the document library.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPLibraryFileVersionBatchDeleteJobStatus</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID, name or Url (Lists/MyList) of the document library to perform the trimming on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID, name or Url (Lists/MyList) of the document library to perform the trimming on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPLibraryFileVersionBatchDeleteJobStatus -Identity "Documents" ```</maml:para> <maml:para>Returns the progress of deleting existing file versions on the document library.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPLibraryFileVersionExpirationReportJobStatus</command:name> <maml:description> <maml:para>Gets the status for a file version usage report generation job for a document library.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPLibraryFileVersionExpirationReportJobStatus</command:noun> </command:details> <maml:description> <maml:para>Gets the status for a file version usage report generation job for a document library.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPLibraryFileVersionExpirationReportJobStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID, name or Url (Lists/MyList) of the document library to get the job status on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReportUrl</maml:name> <maml:description> <maml:para>The URL of the report to get the job status on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID, name or Url (Lists/MyList) of the document library to get the job status on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReportUrl</maml:name> <maml:description> <maml:para>The URL of the report to get the job status on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPLibraryFileVersionExpirationReportJobStatus -Identity "Documents" -ReportUrl "https://contoso.sharepoint.com/sites/reports/MyReports/VersionReport.csv" ```</maml:para> <maml:para>Gets the status for a file version usage report generation job for a document library.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPList</command:name> <maml:description> <maml:para>Returns lists from SharePoint</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPList</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns lists in the current web.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPList</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>List of properties</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>List of properties</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPList ```</maml:para> <maml:para>Returns all lists in the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPList -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe ```</maml:para> <maml:para>Returns a list with the given id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPList -Identity Lists/Announcements ```</maml:para> <maml:para>Returns a list with the given url</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPList | Where-Object {$_.RootFolder.ServerRelativeUrl -like "/lists/*"} ```</maml:para> <maml:para>This examples shows how to do wildcard searches on the list URL. It returns all lists whose URL starts with "/lists/" This could also be used to search for strings inside of the URL.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPList -Includes HasUniqueRoleAssignments ```</maml:para> <maml:para>This examples shows how to retrieve additional properties of the list.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPListDesign</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Retrieve List Designs that have been registered on the current tenant.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPListDesign</command:noun> </command:details> <maml:description> <maml:para>Retrieve List Designs that have been registered on the current tenant. When providing a name with -Identity, it returns all list designs with that name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPListDesign</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified, it will retrieve the specified list design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantListDesignPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified, it will retrieve the specified list design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantListDesignPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListDesign ```</maml:para> <maml:para>Returns all registered list designs</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd ``` Returns a specific registered list design by id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListDesign -Identity ListEvent ```</maml:para> <maml:para>Returns a specific registered list design by name</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Get</command:verb> <command:noun>PnPListInformationRightsManagement</command:noun> </command:details> <maml:description> <maml:para>Allows to get the site closure status of the current site or list which has a site policy applied.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPListInformationRightsManagement</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListInformationRightsManagement -List "Documents" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPListItem</command:name> <maml:description> <maml:para>Retrieves list items</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPListItem</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve list items.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPListItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FolderServerRelativeUrl</maml:name> <maml:description> <maml:para>The server relative URL of a list folder from which results will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ScriptBlock</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPListItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPListItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UniqueId</maml:name> <maml:description> <maml:para>The UniqueId or GUID of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPListItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FolderServerRelativeUrl</maml:name> <maml:description> <maml:para>The server relative URL of a list folder from which results will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ScriptBlock</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FolderServerRelativeUrl</maml:name> <maml:description> <maml:para>The server relative URL of a list folder from which results will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeContentType</maml:name> <maml:description> <maml:para>If specified, it will retrieve the content type information of the list item(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Switch Parameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The list to query</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ScriptBlock</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>UniqueId</maml:name> <maml:description> <maml:para>The UniqueId or GUID of the item to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItem -List Tasks ```</maml:para> <maml:para>Retrieves all list items from the Tasks list</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItem -List Tasks -Id 1 ```</maml:para> <maml:para>Retrieves the list item with ID 1 from the Tasks list</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItem -List Tasks -UniqueId bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3 ```</maml:para> <maml:para>Retrieves the list item with UniqueId or GUID bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3 from the tasks lists</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell (Get-PnPListItem -List Tasks -Fields "Title","GUID").FieldValues ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell 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>" ```</maml:para> <maml:para>Retrieves all available fields of list items based on the CAML query specified</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItem -List Tasks -Query "<View><ViewFields><FieldRef Name='Title'/><FieldRef Name='Modified'/></ViewFields><Query><Where><Eq><FieldRef Name='Modified'/><Value Type='DateTime'><Today/></Value></Eq></Where></Query></View>" ```</maml:para> <maml:para>Retrieves all list items modified today, retrieving the columns 'Title' and 'Modified'. When you use -Query, you can add a `<ViewFields>` clause to retrieve specific columns (since you cannot use -Fields)</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItem -List Tasks -PageSize 1000 ```</maml:para> <maml:para>Retrieves all list items from the Tasks list in pages of 1000 items</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItem -List Tasks -PageSize 1000 -ScriptBlock { Param($items) $items.Context.ExecuteQuery() } | ForEach-Object { $_.BreakRoleInheritance($true, $true) } ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 9 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItem -List Samples -FolderServerRelativeUrl "/sites/contosomarketing/Lists/Samples/Demo" ```</maml:para> <maml:para>Retrieves all list items from the Demo folder in the Samples list located in the contosomarketing site collection</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 10 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS D:\Code> Get-PnPListItem -List "Shared Documents" | Select-Object id,@{label="Filename";expression={$_.FieldValues.FileLeafRef}}</maml:para> <maml:para>Id Filename -- -------- 1 Contoso-Financial-Calendar-Q1_68340_97779.pptx 5 Does this work.docx ```</maml:para> <maml:para>Retrieves all list items from the Shared Documents and shows each item's ID and Filename</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 11 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItem -List Tasks -Id 1 -IncludeContentType ```</maml:para> <maml:para>Retrieves the list item with ID 1 from the Tasks list along with its content type information.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPListItemAttachment</command:name> <maml:description> <maml:para>Downloads the list item attachments to a specified path on the file system.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPListItemAttachment</command:noun> </command:details> <maml:description> <maml:para>Allows to download the list item attachments to a specified path. Use `Force` option in order to skip the confirmation question and overwrite the files on the local disk, if they already exist.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPListItemAttachment</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question and overwrite the files on the local disk, if they already exist.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list. Note that when providing the name of the list, the name is case-sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the path on the local file system to download the list item attachments to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specifying the Force parameter will skip the confirmation question and overwrite the files on the local disk, if they already exist.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID, Title or Url of the list. Note that when providing the name of the list, the name is case-sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the path on the local file system to download the list item attachments to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItemAttachment -List "Demo List" -Identity 1 -Path "C:\temp" ```</maml:para> <maml:para>Downloads all attachments from the list item with Id "1" in the "Demo List" SharePoint list and stores them in the temp folder.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItemAttachment -List "Demo List" -Identity 1 -Path "C:\temp" -Force ```</maml:para> <maml:para>Downloads all attachments from the list item with Id "1" in the "Demo List" SharePoint list and stores them in the temp folder overwriting the files if they already exist.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPListItemComment</command:name> <maml:description> <maml:para>Retrieves all comments from the list item in the specified list.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPListItemComment</command:noun> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPListItemComment</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItemComment -List Tasks -Identity 1 ```</maml:para> <maml:para>Retrieves all comments for the specified list item from the Tasks list</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPListItemPermission</command:name> <maml:description> <maml:para>Gets list item permissions.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPListItemPermission</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve list item permissions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name> Get-PnPListItemPermission</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItemPermission -List 'Documents' -Identity 1 ```</maml:para> <maml:para>Get the permissions for listitem with id 1 in the list 'Documents'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPListItemVersion</command:name> <maml:description> <maml:para>Retrieves the previous versions of a list item.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPListItemVersion</command:noun> </command:details> <maml:description> <maml:para>This cmdlet retrieves the version history of a list item.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPListItemVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>The ID or label of the version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>The ID or label of the version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListItemPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListItemVersion -List "Demo List" -Identity 1 ```</maml:para> <maml:para>Retrieves the list item version history.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPListPermissions</command:name> <maml:description> <maml:para>Returns the permissions for a specific SharePoint List given a user or group by id.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPListPermissions</command:noun> </command:details> <maml:description> <maml:para>This cmdlet retrieves the list permissions (role definitions) for a specific user or group in a provided list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPListPermissions</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id, name or server relative url of the list to retrieve the permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>PrincipalId</maml:name> <maml:description> <maml:para>The id of a user or a SharePoint group. See Get-PnPUser and Get-PnPGroup.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id, name or server relative url of the list to retrieve the permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>PrincipalId</maml:name> <maml:description> <maml:para>The id of a user or a SharePoint group. See Get-PnPUser and Get-PnPGroup.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListPermissions -Identity DemoList -PrincipalId 60 ```</maml:para> <maml:para>Returns the permissions for the SharePoint group with id for the list DemoList.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListPermissions -Identity DemoList -PrincipalId (Get-PnPGroup -Identity DemoGroup).Id ```</maml:para> <maml:para>Returns the permissions for the SharePoint group call DemoGroup for the list DemoList.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPListRecordDeclaration</command:name> <maml:description> <maml:para>Returns the manual record declaration settings for a list</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPListRecordDeclaration</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve the record declaration settings for given list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPListRecordDeclaration</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPListRecordDeclaration -List "Documents" ```</maml:para> <maml:para>Returns the record declaration setting for the list "Documents"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPManagedAppId</command:name> <maml:description> <maml:para>Retrieve an App Id associated with a Url from either the Windows Credential Manager, the MacOS Key chain or if you use the Microsoft.PowerShell.SecretManagement module, a default vault.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPManagedAppId</command:noun> </command:details> <maml:description> <maml:para>Returns an associated App Id from the Windows Credential Manager or Mac OS Key Chain Entry.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPManagedAppId</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url for which to retrieve the associated App Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>The Url for which to retrieve the associated App Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPManagedAppId -Url https://yourtenant.sharepoint.com ```</maml:para> <maml:para>Returns the App Id associated with the specified tenant Url.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Get</command:verb> <command:noun>PnPMasterPage</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve urls of the default Master Page and custom Master Page of the current site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPMasterPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMasterPage ```</maml:para> <maml:para>This will return the urls of the default Master Page and custom Master Page of the current site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPMessageCenterAnnouncement</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : ServiceMessage.Read.All Gets message center announcements of the Office 365 Services from the Microsoft Graph API</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPMessageCenterAnnouncement</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve the available message center announcements.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPMessageCenterAnnouncement</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">Identity</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">Identity</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMessageCenterAnnouncement ```</maml:para> <maml:para>Retrieves all the available message center announcements</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMessageCenterAnnouncement -Identity "MC123456" ```</maml:para> <maml:para>Retrieves the details of the message center announcement with the Id MC123456</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPMicrosoft365ExpiringGroup</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Directory.Read.All, Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, GroupMember.Read.All, GroupMember.ReadWrite.All Gets all soon to expire Microsoft 365 Groups.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPMicrosoft365ExpiringGroup</command:noun> </command:details> <maml:description> <maml:para>This command returns all soon to expire Microsoft 365 Groups. By default, groups expiring in the next 31 days are returned (in accordance with SharePoint/OneDrive's retention period's 31-day months). The `-Limit` parameter can be used to specify a different time period.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPMicrosoft365ExpiringGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limits Groups to be returned to Groups expiring in as many days.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Limits Groups to be returned to Groups expiring in as many days.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365ExpiringGroup ```</maml:para> <maml:para>Returns all Groups expiring within 31 days (roughly 1 month).</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365ExpiringGroup -Limit 93 ```</maml:para> <maml:para>Returns all Microsoft 365 Groups expiring in 93 days (roughly 3 months)</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPMicrosoft365Group</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Directory.Read.All, Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, GroupMember.Read.All, GroupMember.ReadWrite.All Gets one Microsoft 365 Group or a list of Microsoft 365 Groups</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPMicrosoft365Group</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve Microsoft 365 Groups. By using `Identity` option you may specify the exact group that will be retrieved.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPMicrosoft365Group</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>When provided, the following properties originating from Exchange Online, will also be loaded into the returned group. Without providing this flag, they will not be populated. Providing this flag causes an extra call to be made to Microsoft Graph, so only add it when you need one of the properties below.</maml:para> <maml:para>- AutoSubscribeNewMembers - RequireSenderAuthenticationEnabled - IsSubscribedByMail</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeOwners</maml:name> <maml:description> <maml:para>Include fetching the group owners. This slows down large listings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSensitivityLabels</maml:name> <maml:description> <maml:para>Include fetching the sensitivity labels. This slows down large listings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSiteUrl</maml:name> <maml:description> <maml:para>Include fetching the site URL for Microsoft 365 Groups. This slows down large listings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>When provided, the following properties originating from Exchange Online, will also be loaded into the returned group. Without providing this flag, they will not be populated. Providing this flag causes an extra call to be made to Microsoft Graph, so only add it when you need one of the properties below.</maml:para> <maml:para>- AutoSubscribeNewMembers - RequireSenderAuthenticationEnabled - IsSubscribedByMail</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specify the query to pass to Graph API in $filter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeOwners</maml:name> <maml:description> <maml:para>Include fetching the group owners. This slows down large listings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSensitivityLabels</maml:name> <maml:description> <maml:para>Include fetching the sensitivity labels. This slows down large listings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSiteUrl</maml:name> <maml:description> <maml:para>Include fetching the site URL for Microsoft 365 Groups. This slows down large listings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365Group ```</maml:para> <maml:para>Retrieves all the Microsoft 365 Groups</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365Group -Identity $groupId ```</maml:para> <maml:para>Retrieves a specific Microsoft 365 Group based on its ID</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365Group -Identity $groupDisplayName ```</maml:para> <maml:para>Retrieves a specific or list of Microsoft 365 Groups that start with the given DisplayName</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365Group -Identity $groupSiteMailNickName ```</maml:para> <maml:para>Retrieves a specific or list of Microsoft 365 Groups for which the email starts with the provided mail nickName</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365Group -Identity $group ```</maml:para> <maml:para>Retrieves a specific Microsoft 365 Group based on its object instance</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365Group -IncludeSiteUrl ```</maml:para> <maml:para>Retrieves all Microsoft 365 Groups in this tenant and includes the URL property for the underlying SharePoint site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell $groups = Get-PnPMicrosoft365Group -IncludeOwners $g[0].Owners ```</maml:para> <maml:para>Retrieves all Microsoft 365 Groups in this tenant and retrieves the owners for each group. The owners are available in the "Owners" property of the returned objects.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell $groups = Get-PnPMicrosoft365Group -Filter "startswith(description, 'contoso')" ```</maml:para> <maml:para>Retrieves all Microsoft 365 Groups in this tenant with description starting with Contoso. This example demonstrates using Advanced Query capabilities (see: https://learn.microsoft.com/graph/aad-advanced-queries?tabs=http#group-properties).</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPMicrosoft365GroupEndpoint</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : Group.Read.All Returns the endpoints behind a particular Microsoft 365 Group</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPMicrosoft365GroupEndpoint</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows retrieval of details on the endpoints connected to a Microsoft 365 Group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPMicrosoft365GroupEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupEndpoint ```</maml:para> <maml:para>Retrieves the endpoints behind the Microsoft 365 Group of the currently connected to site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupEndpoint -Identity "IT Team" ```</maml:para> <maml:para>Retrieves the endpoints behind the Microsoft 365 Group named "IT Team"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupEndpoint -Identity e6212531-7f09-4c3b-bc2e-12cae26fb409 ```</maml:para> <maml:para>Retrieves the endpoints behind the Microsoft 365 Group with the provided Id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPMicrosoft365GroupMember</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : at least Group.Read.All * Microsoft Graph API : Directory.Read.All Returns the members of a particular Microsoft 365 Group</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPMicrosoft365GroupMember</command:noun> </command:details> <maml:description> <maml:para>Returns the members of a particular Microsoft 365 Group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPMicrosoft365GroupMember</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupMember -Identity $groupId ```</maml:para> <maml:para>Retrieves all the members of a specific Microsoft 365 Group based on its ID</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupMember -Identity $group ```</maml:para> <maml:para>Retrieves all the members of a specific Microsoft 365 Group based on the group's object instance</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupMember -Identity "Sales" | Where-Object UserType -eq Guest ```</maml:para> <maml:para>Returns all the guest users of the Microsoft 365 Group named "Sales"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPMicrosoft365GroupOwner</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : at least Group.Read.All * Microsoft Graph API : Directory.Read.All Gets owners of a particular Microsoft 365 Group</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPMicrosoft365GroupOwner</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve owners of Microsoft 365 Group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPMicrosoft365GroupOwner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupOwner -Identity $groupId ```</maml:para> <maml:para>Retrieves all the owners of a specific Microsoft 365 Group based on its ID</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupOwner -Identity $group ```</maml:para> <maml:para>Retrieves all the owners of a specific Microsoft 365 Group based on the group's object instance</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPMicrosoft365GroupSettings</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : Directory.Read.All Gets a settings of a specific Microsoft 365 Group or a tenant wide Microsoft 365 Group Settings.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPMicrosoft365GroupSettings</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve tenant wide settings of Microsoft 365 Groups or by using `Identity` option you may specify the exact Microsoft 365 Group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPMicrosoft365GroupSettings</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>GroupSetting</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group Setting</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Microsoft365GroupSettingsPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>GroupSetting</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group Setting</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Microsoft365GroupSettingsPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupSettings ```</maml:para> <maml:para>Retrieves all the Microsoft 365 Group settings from the Tenant</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupSettings -Identity $groupId ```</maml:para> <maml:para>Retrieves a specific Microsoft 365 Group setting</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupSettings -GroupSetting $groupSettingId ```</maml:para> <maml:para>Retrieves a tenant-wide specific Microsoft 365 Group setting.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupSettings -Identity $groupId -GroupSetting $groupSettingId ```</maml:para> <maml:para>Retrieves a group-specific Microsoft 365 Group setting</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation get settings</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/groupsetting-get</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation list settings</maml:linkText> <command:uri>https://learn.microsoft.com/en-gb/graph/api/group-list-setting</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPMicrosoft365GroupSettingTemplates</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : Directory.Read.All Gets the available system wide template of settings for Microsoft 365 Groups.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPMicrosoft365GroupSettingTemplates</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve available system wide template of settings for Microsoft 365 Groups.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPMicrosoft365GroupSettingTemplates</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group setting template</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group setting template</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">string</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupSettingTemplates ```</maml:para> <maml:para>Retrieves all the available Microsoft 365 Group setting templates from the Tenant</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupSettingTemplates -Identity "08d542b9-071f-4e16-94b0-74abb372e3d9" ```</maml:para> <maml:para>Retrieves a specific Microsoft 365 Group setting template. In the above example, it retrieves the `Group.Unified.Guest` setting template.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/api/groupsettingtemplate-list</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPMicrosoft365GroupTeam</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : Group.Read.All Returns the Microsoft Teams team behind a particular Microsoft 365 Group.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPMicrosoft365GroupTeam</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows retrieval of details on the Microsoft Teams team connected to a Microsoft 365 Group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPMicrosoft365GroupTeam</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupTeam ```</maml:para> <maml:para>Retrieves the Microsoft Teams team details behind the Microsoft 365 Group of the currently connected to site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupTeam -Identity "IT Team" ```</maml:para> <maml:para>Retrieves the Microsoft Teams team details behind the Microsoft 365 Group named "IT Team".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupTeam -Identity e6212531-7f09-4c3b-bc2e-12cae26fb409 ```</maml:para> <maml:para>Retrieves the Microsoft Teams team details behind the Microsoft 365 Group with the provided Id.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPMicrosoft365GroupYammerCommunity</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : Group.Read.All Returns the Yammer Community behind a particular Microsoft 365 Group</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPMicrosoft365GroupYammerCommunity</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows retrieval of details on the Yammer Community connected to a Microsoft 365 Group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPMicrosoft365GroupYammerCommunity</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Identity of the Microsoft 365 Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Microsoft365GroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupYammerCommunity ```</maml:para> <maml:para>Retrieves the Yammer Community details behind the Microsoft 365 Group of the currently connected to site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupYammerCommunity -Identity "IT Community" ```</maml:para> <maml:para>Retrieves the Yammer Community details behind the Microsoft 365 Group named "IT Community"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365GroupYammerCommunity -Identity e6212531-7f09-4c3b-bc2e-12cae26fb409 ```</maml:para> <maml:para>Retrieves the Yammer Community details behind the Microsoft 365 Group with the provided Id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPMicrosoft365Roadmap</command:name> <maml:description> <maml:para>**Required Permissions** * None Returns all items currently on the Microsoft 365 Roadmap</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPMicrosoft365Roadmap</command:noun> </command:details> <maml:description> <maml:para>Allows retrieval of the Microsoft 365 Roadmap. Pipe the output to i.e. a Where-Object to filter it down to the desired items. You do not need to be connected to any tenant to utilize this cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPMicrosoft365Roadmap</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RoadmapUrl</maml:name> <maml:description> <maml:para>Allows passing in a custom URL to retrieve the roadmap from. It will use the default value listed below if it is not provided. In most cases you don't want to provide this parameter yourself.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RoadmapUrl</maml:name> <maml:description> <maml:para>Allows passing in a custom URL to retrieve the roadmap from. It will use the default value listed below if it is not provided. In most cases you don't want to provide this parameter yourself.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365Roadmap ```</maml:para> <maml:para>Retrieves all the available items currently on the Microsoft 365 Roadmap</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365Roadmap | Where-Object { $_.Status -eq "Rolling out" } ```</maml:para> <maml:para>Retrieves the items on the Microsoft 365 Roadmap which are currently rolling out</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPMicrosoft365Roadmap | Where-Object { $_.Created -ge (Get-Date).AddDays(-7) -or $_.Modified -ge (Get-Date).AddDays(-7) } ```</maml:para> <maml:para>Retrieves the items on the Microsoft 365 Roadmap which have been added or modified in the last 7 days</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft 365 Roadmap</maml:linkText> <command:uri>https://www.microsoft.com/microsoft-365/roadmap</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPNavigationNode</command:name> <maml:description> <maml:para>Returns all or a specific navigation node</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPNavigationNode</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve all navigation nodes or a specific on by using `Id` option.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPNavigationNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location of the nodes to retrieve. Either TopNavigationBar, QuickLaunch, SearchNav or Footer.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">NavigationType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPNavigationNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the node to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the node to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location of the nodes to retrieve. Either TopNavigationBar, QuickLaunch, SearchNav or Footer.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">NavigationType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPNavigationNode ```</maml:para> <maml:para>Returns all navigation nodes in the quicklaunch navigation</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPNavigationNode -Location QuickLaunch ```</maml:para> <maml:para>Returns all navigation nodes in the quicklaunch navigation</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPNavigationNode -Location TopNavigationBar ```</maml:para> <maml:para>Returns all navigation nodes in the top navigation bar</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell $node = Get-PnPNavigationNode -Id 2030 PS> $children = $node.Children ```</maml:para> <maml:para>Returns the selected navigation node and retrieves any children</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPOrgAssetsLibrary</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Returns the list of all the configured organizational asset libraries</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPOrgAssetsLibrary</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve list of all the configured organizational asset libraries.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPOrgAssetsLibrary</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPOrgAssetsLibrary ```</maml:para> <maml:para>Returns the list of all the configured organizational asset sites</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell (Get-PnPOrgAssetsLibrary)[0].OrgAssetsLibraries[0].LibraryUrl.DecodedUrl ```</maml:para> <maml:para>Returns the server relative url of the first document library which has been flagged as organizational asset library, i.e. "sites/branding/logos"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPOrgNewsSite</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Returns the list of all the configured organizational news sites.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPOrgNewsSite</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve list of all the configured organizational news sites.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPOrgNewsSite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPOrgNewsSite ```</maml:para> <maml:para>Returns the list of all the configured organizational news sites.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPage</command:name> <maml:description> <maml:para>Returns a specific or all modern pages (Site Pages) in a SharePoint site.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPage</command:noun> </command:details> <maml:description> <maml:para>This command allows the retrieval of a modern sitepage along with its properties and contents on it. Note that for a newly created modern site, the Columns and Sections of the Home.aspx page will not be filled according to the actual site page contents. This is because the underlying CanvasContent1 will not be populated until the homepage has been edited and published. The reason for this behavior is to allow for the default homepage to be able to be updated by Microsoft as long as it hasn't been modified. For any other site page or after editing and publishing the homepage, this command will return the correct columns and sections as they are positioned on the site page.</maml:para> <maml:para>Also note that if you want to retrieve all site pages in a site by omitting the -Identity parameter, the command will return all pages in the Site Pages library, but with less details and will require SharePoint Online Administrator permissions to do so. This is how it has been designed on the server side. If you want the full details on all pages, you can do it as follows `Get-PnPPage | % { Get-PnPPage -Identity $_.Name }`. Be aware that this causes a lot of server calls and is much slower than the first command.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPPage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPage -Identity "MyPage.aspx" ```</maml:para> <maml:para>Gets the page named 'MyPage.aspx' in the current SharePoint site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPage "MyPage" ```</maml:para> <maml:para>Gets the page named 'MyPage.aspx' in the current SharePoint site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPage "Templates/MyPageTemplate" ```</maml:para> <maml:para>Gets the page named 'MyPageTemplate.aspx' from the templates folder of the Page Library in the current SharePoint site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPage -Identity "MyPage.aspx" -Web (Get-PnPWeb -Identity "Subsite1") ```</maml:para> <maml:para>Gets the page named 'MyPage.aspx' from the subsite named 'Subsite1'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPage ```</maml:para> <maml:para>Returns all site pages in the current SharePoint site. Note that this will return less details than when using the -Identity parameter and requires SharePoint Online Administrator permissions to do so.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPageComponent</command:name> <maml:description> <maml:para>Retrieve one or more page components from a page</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPageComponent</command:noun> </command:details> <maml:description> <maml:para>This command allows the retrieval of the components placed on a modern sitepage along with its properties. Note that for a newly created modern site, the Home.aspx page will not be returning any components. This is because the underlying CanvasContent1 will not be populated until the homepage has been edited and published. The reason for this behavior is to allow for the default homepage to be able to be updated by Microsoft as long as it hasn't been modified. For any other site page or after editing and publishing the homepage, this command will return the correct components as they are positioned on the site page.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPageComponent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>The instance id of the component</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:description> <maml:para>The instance id of the component</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Page</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPageComponent -Page Home ```</maml:para> <maml:para>Returns all controls defined on the given page.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPageComponent -Page Home -InstanceId a2875399-d6ff-43a0-96da-be6ae5875f82 ```</maml:para> <maml:para>Returns a specific control defined on the given page.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPageComponent -Page Home -ListAvailable ```</maml:para> <maml:para>Returns all available components that can be added to the page.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPageCopyProgress</command:name> <maml:description> <maml:para>Allows checking the progress of a site page move or copy operation from one site to another site.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPageCopyProgress</command:noun> </command:details> <maml:description> <maml:para>This command allows checking the progress of a site page move or copy operation from one site to another site. The destination site can be specified using the -DestinationSite parameter, and the work item ID can be specified using the -WorkItemId parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPageCopyProgress</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:description> <maml:para>The destination site to which the page is being moved or copied. This can be specified as a URL or a site object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SPOSitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>WorkItemId</maml:name> <maml:description> <maml:para>The work item ID of the page copy operation. This is a GUID that uniquely identifies the copy operation and is returned when the copy or move operation is initiated using [Copy-PnPPage](Copy-PnPPage.md) and [Move-PnPPage](Move-PnPPage.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:description> <maml:para>The destination site to which the page is being moved or copied. This can be specified as a URL or a site object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SPOSitePipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>WorkItemId</maml:name> <maml:description> <maml:para>The work item ID of the page copy operation. This is a GUID that uniquely identifies the copy operation and is returned when the copy or move operation is initiated using [Copy-PnPPage](Copy-PnPPage.md) and [Move-PnPPage](Move-PnPPage.md).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPageCopyProgress -DestinationSite https://tenant.sharepoint.com -WorkItemId 12345678-1234-1234-1234-123456789012 ```</maml:para> <maml:para>Retrieves the progress of the page copy operation with the specified work item ID to the destination site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>SharePoint Online Management Shell equivallent</maml:linkText> <command:uri>https://learn.microsoft.com/powershell/module/sharepoint-online/get-spopersonalsitepagecopyprogress</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPageLikedByInformation</command:name> <maml:description> <maml:para>Returns liked-by Information of a modern page</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPageLikedByInformation</command:noun> </command:details> <maml:description> <maml:para>This command retrieves the LikedBy Information of a modern page.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPageLikedByInformation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name of the page</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PagePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPageLikedByInformation -Identity "MyPage.aspx" ```</maml:para> <maml:para>Gets the LikedBy Information of page named 'MyPage.aspx' in the current SharePoint site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPageLikedByInformation "MyPage" ```</maml:para> <maml:para>Gets the LikedBy Information of page named 'MyPage.aspx' in the current SharePoint site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPageLikedByInformation -Identity "MyPage.aspx" -Web (Get-PnPWeb -Identity "Subsite1") ```</maml:para> <maml:para>Gets the LikedBy Information of page named 'MyPage.aspx' from the subsite named 'Subsite1'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Sample Output ---------</maml:title> <maml:introduction> <maml:para>```powershell Name : User 1 Mail : Id : 14 LoginName : i:0#.f|membership|user1@contoso.onmicrosoft.com CreationDate : 2024-02-16 14:49:55</maml:para> <maml:para>Name : User 2 Mail : user2@contoso.onmicrosoft.com Id : 6 LoginName : i:0#.f|membership|user2@contoso.onmicrosoft.com CreationDate : 2024-02-22 19:47:24 ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPageSchedulingEnabled</command:name> <maml:description> <maml:para>Return true of false, reflecting the state of the modern page schedule feature</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPageSchedulingEnabled</command:noun> </command:details> <maml:description> <maml:para>This will return a boolean value stating if the modern page schedule feature has been enabled or not.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPageSchedulingEnabled</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPageSchedulingEnabled ```</maml:para> <maml:para>This will return a boolean value stating if the modern page schedule feature has been enabled or not.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPlannerBucket</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: One of Tasks.Read, Tasks.ReadWrite, Tasks.Read.All, Tasks.ReadWrite.All, Group.Read.All, Group.ReadWrite.All Returns all or a specific Planner bucket</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPlannerBucket</command:noun> </command:details> <maml:description> <maml:para>This cmdlets returns all or a specific bucket in a Planner plan.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPlannerBucket</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specify the group id or name of the group owning the plan.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the bucket to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PlannerBucketPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Plan</maml:name> <maml:description> <maml:para>The name or id of the plan containing the bucket.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerPlanPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPPlannerBucket</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the bucket to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PlannerBucketPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PlanId</maml:name> <maml:description> <maml:para>The plan id of the plan containing the bucket</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specify the group id or name of the group owning the plan.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The identity of the bucket to retrieve</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PlannerBucketPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Plan</maml:name> <maml:description> <maml:para>The name or id of the plan containing the bucket.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerPlanPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PlanId</maml:name> <maml:description> <maml:para>The plan id of the plan containing the bucket</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPlannerBucket -Group "Marketing" -Plan "Conference Plan" ```</maml:para> <maml:para>This will returns all buckets in the specified plan</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPlannerConfiguration</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: tasks.office.com Returns the Microsoft Planner configuration of the tenant</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPlannerConfiguration</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns the Microsoft Planner admin configuration of the tenant. Note that after changing the configuration using `Set-PnPPlannerTenantConfiguration`, this cmdlet may return varying results which could deviate from your desired configuration while the new configuration is being propagated across the tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPlannerConfiguration</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPlannerConfiguration ``` Returns the Microsoft Planner configuration of the tenant</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPlannerPlan</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Group.ReadWrite.All * Microsoft Graph API: Group.Read.All Returns all or a specific Planner plan for a Microsoft 365 Group.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPlannerPlan</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns all or a specific Planner plan for a Microsoft 365 Group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPlannerPlan</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specify the group containing the plans</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified the plan with this ID or Name will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PlannerPlanPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ResolveIdentities</maml:name> <maml:description> <maml:para>Show user display names instead of user IDs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPPlannerPlan</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>If specified the plan with this ID will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ResolveIdentities</maml:name> <maml:description> <maml:para>Show user display names instead of user IDs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specify the group containing the plans</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>If specified the plan with this ID will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified the plan with this ID or Name will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PlannerPlanPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ResolveIdentities</maml:name> <maml:description> <maml:para>Show user display names instead of user IDs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPlannerPlan -Group "Marketing" ```</maml:para> <maml:para>Returns all plans for the Marketing group.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPlannerPlan -Group "Marketing" -Identity "Conference Plan" ```</maml:para> <maml:para>Returns the specified plan for the Marketing group.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPlannerPlan -Id "gndWOTSK60GfPQfiDDj43JgACDCb" -ResolveIdentities ```</maml:para> <maml:para>Rerturns the plan with specified ID with resolved identities.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPlannerRosterMember</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: tasks.office.com Returns the current members of a Microsoft Planner Roster</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPlannerRosterMember</command:noun> </command:details> <maml:description> <maml:para>This cmdlet will return the current members of a Microsoft Planner Roster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPlannerRosterMember</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id of the Microsoft Planner Roster plan of which to return its current members</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Id of the Microsoft Planner Roster plan of which to return its current members</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPlannerRosterMember -Identity "6519868f-868f-6519-8f86-19658f861965" ``` Returns the current members of a Microsoft Planner Roster with the provided Id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPlannerRosterPlan</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Tasks.ReadWrite * Microsoft Graph API: Tasks.Read Returns Microsoft Planner roster plans for a specific Microsoft Planner Roster or a specific user</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPlannerRosterPlan</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns Microsoft Planner roster plans for a specific Microsoft Planner Roster or a specific user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPlannerRosterPlan</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>A Microsoft Planner Roster Id or instance. Documentation: https://learn.microsoft.com/graph/api/plannerroster-list-plans?view=graph-rest-beta&tabs=http</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user principal name to query for. Documentation: https://learn.microsoft.com/graph/api/planneruser-list-rosterplans?view=graph-rest-beta&tabs=http</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPlannerRosterPlan -Identity "abcdefgh" ```</maml:para> <maml:para>Returns all plans inside the roster with the provided identifier</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPlannerRosterPlan -User "johndoe@contoso.onmicrosoft.com" ```</maml:para> <maml:para>Returns all roster plans for the provided user</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPlannerTask</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: One of Tasks.Read, Tasks.ReadWrite, Tasks.Read.All, Tasks.ReadWrite.All, Group.Read.All, Group.ReadWrite.All Returns Planner tasks</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPlannerTask</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns Planner tasks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPlannerTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specify the group id or name of group owning the plan.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Plan</maml:name> <maml:description> <maml:para>Specify the id or name of the plan to retrieve the tasks for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerPlanPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ResolveUserDisplayNames</maml:name> <maml:description> <maml:para>Will resolve user id's to usernames</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPPlannerTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Specify the bucket or bucket id to retrieve the tasks for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerBucketPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ResolveUserDisplayNames</maml:name> <maml:description> <maml:para>Will resolve user id's to usernames</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPPlannerTask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PlanId</maml:name> <maml:description> <maml:para>Specify the id of the plan to retrieve the tasks for.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ResolveUserDisplayNames</maml:name> <maml:description> <maml:para>Will resolve user id's to usernames</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPPlannerTask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeDetails</maml:name> <maml:description> <maml:para>Includes checklist and description details</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ResolveUserDisplayNames</maml:name> <maml:description> <maml:para>Will resolve user id's to usernames</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specify the id of the task to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Specify the bucket or bucket id to retrieve the tasks for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerBucketPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specify the group id or name of group owning the plan.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerGroupPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeDetails</maml:name> <maml:description> <maml:para>Includes checklist and description details</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Plan</maml:name> <maml:description> <maml:para>Specify the id or name of the plan to retrieve the tasks for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PlannerPlanPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PlanId</maml:name> <maml:description> <maml:para>Specify the id of the plan to retrieve the tasks for.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ResolveUserDisplayNames</maml:name> <maml:description> <maml:para>Will resolve user id's to usernames</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specify the id of the task to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPlannerTask -Group "Marketing" -Plan "Conference Plan" ```</maml:para> <maml:para>This returns all tasks for the specific plan.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell $tasks = Get-PnPPlannerTask -Group "Marketing" -Plan "Conference Plan" -ResolveUserDiplayNames $task = $tasks | Select-Object -First 1 $task.CreatedBy.DisplayName ```</maml:para> <maml:para>This retrieves all tasks for a specific plan, takes the first task and prints the display name of the user that created the task.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPlannerTask -PlanId "QvfkTd1mc02gwxHjHC_43JYABhAy" ```</maml:para> <maml:para>This returns all tasks for the specified plan.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPlannerTask -TaskId "QvfkTd1mc02gwxHjHC_43JYABhAy" ```</maml:para> <maml:para>This returns a specific task.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPlannerUserPolicy</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: tasks.office.com Returns the Microsoft Planner user policy for a specific user</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPlannerUserPolicy</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns the Microsoft Planner user policy for the provided user. If a Microsoft Planner user policy has never been set yet on a tenant, this cmdlet may return a '403 Forbidden: Access is denied' error. Set a policy once first to enable the background configuration to be done so this cmdlet can succeed from thereon.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPlannerUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Azure Active Directory user identifier or user principal name of the user to retrieve the Microsoft Planner policy for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Azure Active Directory user identifier or user principal name of the user to retrieve the Microsoft Planner policy for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPlannerUserPolicy -Identity "johndoe@contoso.onmicrosoft.com" ``` Returns the Microsoft Planner user policy for the provided user</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPowerApp</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: management.azure.com Returns the Power Apps for a given environment</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPowerApp</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns the Power Apps for a given enviroment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPowerApp</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>If specified returns all the Power Apps as admin. If not specified only the apps for the current user will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id of the app to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerAppPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>If specified returns all the Power Apps as admin. If not specified only the apps for the current user will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id of the app to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerAppPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPowerApp ``` This returns all the apps for the default environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPowerApp -Environment (Get-PnPPowerPlatformEnvironment -Identity "myenvironment") -Identity fba63225-baf9-4d76-86a1-1b42c917a182 ``` This returns a specific app from a specific environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPowerPlatformCustomConnector</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: management.azure.com Returns the custom Power Platform Connectors for a given environment</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPowerPlatformCustomConnector</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns the custom connectors on a given enviroment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPowerPlatformCustomConnector</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>If specified returns all the custom connectors as admin. If not specified only the custom connectors for the current user will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id of the connector to retrieve. If not provided, all custom connectors will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformConnectorPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AsAdmin</maml:name> <maml:description> <maml:para>If specified returns all the custom connectors as admin. If not specified only the custom connectors for the current user will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The Id of the connector to retrieve. If not provided, all custom connectors will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformConnectorPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPowerPlatformCustomConnector -Environment (Get-PnPPowerPlatformEnvironment -Identity "myenvironment") ``` This returns all the custom connectors for a given Power Platform environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PowerPlatformConnectorPipeBind -Identity fba63225-baf9-4d76-86a1-1b42c917a182 ``` This returns a specific custom connector on the default Power Platform environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPowerPlatformEnvironment</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: management.azure.com Retrieves the Microsoft Power Platform environments for the current tenant.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPowerPlatformEnvironment</command:noun> </command:details> <maml:description> <maml:para>This cmdlet retrieves all of the Microsoft Power Platform environments for the current tenant</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPowerPlatformEnvironment</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Allows retrieval of the default Power Platform environment by passing in `-IsDefault $true`. When passing in `-IsDefault $false` you will get all non default environments. If not provided at all, all available environments, both default and non-default, will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">bool</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPPowerPlatformEnvironment</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Allows specifying an environment display name or internal name to retrieve a specific environment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">bool</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Allows specifying an environment display name or internal name to retrieve a specific environment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Allows retrieval of the default Power Platform environment by passing in `-IsDefault $true`. When passing in `-IsDefault $false` you will get all non default environments. If not provided at all, all available environments, both default and non-default, will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPowerPlatformEnvironment ```</maml:para> <maml:para>This cmdlets returns all of the Power Platform environments for the current tenant.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPowerPlatformEnvironment -IsDefault $true ```</maml:para> <maml:para>This cmdlets returns the default Power Platform environment for the current tenant.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPowerPlatformEnvironment -Identity "MyOrganization (default)" ```</maml:para> <maml:para>This cmdlets returns the Power Platform environment with the provided display name for the current tenant.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPowerPlatformSolution</command:name> <maml:description> <maml:para>**Required Permissions** * Azure: management.azure.com Returns the Power Platform Solution/s for a given environment</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPowerPlatformSolution</command:noun> </command:details> <maml:description> <maml:para>This cmdlet returns the PowerPlatform solution on a given enviroment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPowerPlatformSolution</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the solution to retrieve. If not provided, all the solutions will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformSolutionPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Power Platform environment or an Environment instance. If omitted, the default environment will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformEnvironmentPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the solution to retrieve. If not provided, all the solutions will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PowerPlatformSolutionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPowerPlatformSolution -Environment (Get-PnPPowerPlatformEnvironment -Identity "myenvironment") ``` This returns all the solutions for a given Power Platform environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPowerPlatformSolution -Name 'My Solution Name' ``` This returns a specific solution on the default Power Platform environment</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Get</command:verb> <command:noun>PnPPowerShellTelemetryEnabled</command:noun> </command:details> <maml:description> <maml:para>In order to help to make PnP PowerShell better, we can track anonymous telemetry. For more information on what we collect and how to prevent this data from being collected, visit [Configure PnP PowerShell](https://pnp.github.io/powershell/articles/configuration.html).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPowerShellTelemetryEnabled</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPowerShellTelemetryEnabled ```</maml:para> <maml:para>Will return true or false.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPriviledgedIdentityManagementEligibleAssignment</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph: RoleAssignmentSchedule.Read.Directory Retrieve the available Privileged Identity Management eligibility assignment roles that exist within the tenant</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPriviledgedIdentityManagementEligibleAssignment</command:noun> </command:details> <maml:description> <maml:para>Retrieve the available Privileged Identity Management eligibility assignment roles that exist within the tenant. These are the configured users with the configured roles they can be elevated to.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPriviledgedIdentityManagementEligibleAssignment</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name, id or instance of a Priviledged Identity Management eligibility assignment role to retrieve the details of</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PriviledgedIdentityManagementRoleEligibilitySchedulePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name, id or instance of a Priviledged Identity Management eligibility assignment role to retrieve the details of</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PriviledgedIdentityManagementRoleEligibilitySchedulePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPriviledgedIdentityManagementEligibleAssignment ```</maml:para> <maml:para>Retrieves the available Privileged Identity Management eligibility assignment roles</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPriviledgedIdentityManagementEligibleAssignment -Identity 62e90394-69f5-4237-9190-012177145e10 ```</maml:para> <maml:para>Retrieves the Privileged Identity Management eligibility assignment role with the provided id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPriviledgedIdentityManagementRole</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph: RoleManagement.Read.Directory Retrieve the available Privileged Identity Management roles that exist within the tenant</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPriviledgedIdentityManagementRole</command:noun> </command:details> <maml:description> <maml:para>Retrieve the available Privileged Identity Management roles that exist within the tenant. These are the roles to which elevation can take place.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPriviledgedIdentityManagementRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name, id or instance of a Priviledged Identity Management role to retrieve the details of</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PriviledgedIdentityManagementRolePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name, id or instance of a Priviledged Identity Management role to retrieve the details of</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PriviledgedIdentityManagementRolePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPriviledgedIdentityManagementRole ```</maml:para> <maml:para>Retrieves the available Privileged Identity Management roles</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPriviledgedIdentityManagementRole -Identity "Global Administrator" ```</maml:para> <maml:para>Retrieves the Privileged Identity Management with the provided name</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPriviledgedIdentityManagementRole -Identity 62e90394-69f5-4237-9190-012177145e10 ```</maml:para> <maml:para>Retrieves the Privileged Identity Management role with the provided id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPProfileCardProperty</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of PeopleSettings.Read.All, PeopleSettings.ReadWrite.All Retrieves custom properties added to user profile cards</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPProfileCardProperty</command:noun> </command:details> <maml:description> <maml:para>This cmdlet may be used to retrieve custom properties added to user profile card.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPProfileCardProperty</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Name of the property to be retrieved. If not provided, all properties will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Commands.Enums.ProfileCardPropertyName</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Name of the property to be retrieved. If not provided, all properties will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Commands.Enums.ProfileCardPropertyName</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPProfileCardProperty ```</maml:para> <maml:para>This will retrieve all custom properties added to user profile card.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPProfileCardProperty -PropertyName "pnppowershell" ```</maml:para> <maml:para>This will return information about the specified property added to a profile card.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/en-us/graph/add-properties-profilecard</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Get</command:verb> <command:noun>PnPProperty</command:noun> </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" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ClientObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <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" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ClientObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <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" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell $web = Get-PnPWeb Get-PnPProperty -ClientObject $web -Property Id, Lists $web.Lists ```</maml:para> <maml:para>Will load both the Id and Lists properties of the specified Web object.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell $list = Get-PnPList -Identity 'Site Assets' Get-PnPProperty -ClientObject $list -Property Views ```</maml:para> <maml:para>Will load the views object of the specified list object and return its value to the output.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPPropertyBag</command:name> <maml:description> <maml:para>Returns the property bag values.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPPropertyBag</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve all property bag values. It is possible to get property bag values for a folder using `Folder` option or a specific property bag value using `Key` option.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPropertyBag</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key that should be looked up</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key that should be looked up</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPropertyBag ```</maml:para> <maml:para>This will return all web property bag values</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPropertyBag -Key MyKey ```</maml:para> <maml:para>This will return the value of the key MyKey from the web property bag</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPropertyBag -Folder /MyFolder ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPropertyBag -Folder /MyFolder -Key vti_mykey ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPropertyBag -Folder / -Key vti_mykey ```</maml:para> <maml:para>This will return the value of the key vti_mykey from the root folder of the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Get</command:verb> <command:noun>PnPPublishingImageRendition</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve all image renditions or a specific one when `Identity` option is used.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPPublishingImageRendition</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ImageRenditionPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">ImageRenditionPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPublishingImageRendition ```</maml:para> <maml:para>Returns all Image Renditions</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPublishingImageRendition -Identity "Test" ```</maml:para> <maml:para>Returns the image rendition named "Test"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPPublishingImageRendition -Identity 2 ```</maml:para> <maml:para>Returns the image rendition where its id equals 2</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPRecycleBinItem</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Site Collection Administrator. SharePoint Tenant Admin alone is not enough Returns one or more items from the Recycle Bin.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPRecycleBinItem</command:noun> </command:details> <maml:description> <maml:para>This command will return all the items in the recycle bin for the SharePoint site you connected to with Connect-PnPOnline. You must connect as a Site Collection Owner or Administrator. The SharePoint Admin Role in the tenant alone will not work. If you are not a Site Collection Admin connect to the Tenant Admin URL with Connect-PnPOnline and use Get-PnPTenantRecycleBinItem.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPRecycleBinItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned recycle bin items which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>Limits returned results to specified amount</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPRecycleBinItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned recycle bin items which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPRecycleBinItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FirstStage</maml:name> <maml:description> <maml:para>Returns all items in the first stage recycle bin</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned recycle bin items which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>Limits returned results to specified amount</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPRecycleBinItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned recycle bin items which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>Limits returned results to specified amount</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SecondStage</maml:name> <maml:description> <maml:para>Returns all items in the second stage recycle bin.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>FirstStage</maml:name> <maml:description> <maml:para>Returns all items in the first stage recycle bin</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned recycle bin items which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RowLimit</maml:name> <maml:description> <maml:para>Limits returned results to specified amount</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SecondStage</maml:name> <maml:description> <maml:para>Returns all items in the second stage recycle bin.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPRecycleBinItem ```</maml:para> <maml:para>Returns all items in both the first and the second stage recycle bins in the current site collection.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPRecycleBinItem -Identity f3ef6195-9400-4121-9d1c-c997fb5b86c2 ```</maml:para> <maml:para>Returns a specific recycle bin item by id.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPRecycleBinItem -FirstStage ```</maml:para> <maml:para>Returns all items in only the first stage recycle bin in the current site collection.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPRecycleBinItem -SecondStage ```</maml:para> <maml:para>Returns all items in only the second stage recycle bin in the current site collection.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPRecycleBinItem -RowLimit 10000 ```</maml:para> <maml:para>Returns items in recycle bin limited by number of results.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPRequestAccessEmails</command:name> <maml:description> <maml:para>Returns the request access e-mail addresses</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPRequestAccessEmails</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve request access e-mail addresses.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPRequestAccessEmails</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPRequestAccessEmails ```</maml:para> <maml:para>This will return all the request access e-mail addresses for the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPRetentionLabel</command:name> <maml:description> <maml:para>Gets the Office 365 retention label/tag of the specified list or library (if applicable)</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPRetentionLabel</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve all retention labels for current site or list. Use `Raw` option if you want will include more detailed information regarding labels.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPRetentionLabel</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>If provided, the results will be returned as values instead of in written text and will include more detailed information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>The ID or Url of the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>If provided, the results will be returned as values instead of in written text and will include more detailed information</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPRetentionLabel ```</maml:para> <maml:para>Returns all retention labels for the current web</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPRetentionLabel -List "Demo List" -ValuesOnly ```</maml:para> <maml:para>This gets the retention label which is set to a list or a library</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPRoleDefinition</command:name> <maml:description> <maml:para>Retrieves a Role Definitions of a site</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPRoleDefinition</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve Role Definitions of a site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPRoleDefinition</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">RoleDefinitionPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">RoleDefinitionPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPRoleDefinition ```</maml:para> <maml:para>Retrieves the Role Definitions (Permission Levels) settings of the current site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPRoleDefinition -Identity Read ```</maml:para> <maml:para>Retrieves the specified Role Definition (Permission Level) settings of the current site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPRoleDefinition | Where-Object { $_.RoleTypeKind -eq "Administrator" } ```</maml:para> <maml:para>Retrieves the Role Definition (Permission Level) settings with the Administrator type, regardless of its name</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSearchConfiguration</command:name> <maml:description> <maml:para>Returns the search configuration</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSearchConfiguration</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve search configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSearchConfiguration</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SearchConfigurationScope</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPSearchConfiguration</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">OutputFormat</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SearchConfigurationScope</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPSearchConfiguration</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SearchConfigurationScope</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>BookmarkStatus</maml:name> <maml:description> <maml:para>Output bookmarks to be in suggested or published status upon CSV import. Defaults to suggested status.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">BookmarkStatus</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeVisualPromotedResults</maml:name> <maml:description> <maml:para>Exclude promoted results marked as "Render the URL as a banner instead of as a hyperlink". Defaults to true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">OutputFormat</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>PromotedResultsToBookmarkCSV</maml:name> <maml:description> <maml:para>Output promoted results to a compatible CSV file to be used as Bookmark import at https://admin.microsoft.com/#/MicrosoftSearch/bookmarks.</maml:para> <maml:para>Export details:</maml:para> <maml:para>- Promoted results marked as "Render the URL as a banner instead of as a hyperlink" (visual promoted results) and query rules with no triggers will be skipped by default. - Triggers set to "Advanced Query Text Match" and "Query Contains Action Term" will have "Match Similar Keywords" set to true for the Bookmark. - Multiple triggers on a query rule will be merged into a single trigger.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SearchConfigurationScope</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchConfiguration ```</maml:para> <maml:para>Returns the search configuration for the current web.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchConfiguration -Scope Site ```</maml:para> <maml:para>Returns the search configuration for the current site collection.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchConfiguration -Scope Subscription ```</maml:para> <maml:para>Returns the search configuration for the current tenant.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchConfiguration -Path searchconfig.xml -Scope Subscription ```</maml:para> <maml:para>Returns the search configuration for the current tenant and saves it to the specified file.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchConfiguration -Scope Site -OutputFormat ManagedPropertyMappings ```</maml:para> <maml:para>Returns all custom managed properties and crawled property mapping at the current site collection.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchConfiguration -Scope Site -PromotedResultsToBookmarkCSV -Path bookmarks.csv ```</maml:para> <maml:para>Export promoted results excluding visual ones from query rules on the site collection as a CSV file with the bookmarks in suggested status.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchConfiguration -Scope Site -PromotedResultsToBookmarkCSV -Path bookmarks.csv -BookmarkStatus Published ```</maml:para> <maml:para>Export promoted results excluding visual from query rules on the site collection as a CSV file with the bookmarks in published status.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchConfiguration -Scope Subscription -PromotedResultsToBookmarkCSV -ExcludeVisualPromotedResults $false ```</maml:para> <maml:para>Export promoted results including visual ones from query rules on the tenant in CSV format with the bookmarks in suggested status.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSearchCrawlLog</command:name> <maml:description> <maml:para>Returns entries from the SharePoint search crawl log. Make sure you are granted access to the crawl log via the SharePoint search admin center at https://<tenant>-admin.sharepoint.com/_layouts/15/searchadmin/crawllogreadpermission.aspx in order to run this cmdlet.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSearchCrawlLog</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve entries from the SharePoint search crawl log. To be able to use this command you need to grant access to the crawl log via the SharePoint search admin center at https://<tenant>-admin.sharepoint.com/_layouts/15/searchadmin/crawllogreadpermission.aspx.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSearchCrawlLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentSource</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">LogLevel</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RawFormat</maml:name> <maml:description> <maml:para>Show raw crawl log data</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ContentSource</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">LogLevel</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>RawFormat</maml:name> <maml:description> <maml:para>Show raw crawl log data</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">DateTime</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchCrawlLog ```</maml:para> <maml:para>Returns the last 100 crawl log entries for site content.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchCrawlLog -Filter "https://contoso-my.sharepoint.com/personal" ```</maml:para> <maml:para>Returns the last 100 crawl log entries for OneDrive content.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchCrawlLog -ContentSource UserProfiles ```</maml:para> <maml:para>Returns the last 100 crawl log entries for user profiles.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchCrawlLog -ContentSource UserProfiles -Filter "mikael" ```</maml:para> <maml:para>Returns the last 100 crawl log entries for user profiles with the term "mikael" in the user principal name.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchCrawlLog -ContentSource Sites -LogLevel Error -RowLimit 10 ```</maml:para> <maml:para>Returns the last 10 crawl log entries with a state of Error for site content.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchCrawlLog -EndDate (Get-Date).AddDays(-100) ```</maml:para> <maml:para>Returns the last 100 crawl log entries up until 100 days ago.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchCrawlLog -RowFilter 3 -RawFormat ```</maml:para> <maml:para>Returns the last 3 crawl log entries showing the raw crawl log data.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSearchExternalConnection</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of ExternalConnection.ReadWrite.OwnedBy, ExternalConnection.Read.All, ExternalConnection.ReadWrite.All Retrieves all connections to external datasources belonging to Microsoft Search</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSearchExternalConnection</command:noun> </command:details> <maml:description> <maml:para>This cmdlet can be used to retrieve all connections to external datasources that are being indexed into Microsoft Search through a custom connector. Use [Set-PnPSearchExternalItem](Set-PnPSearchExternalItem.md) to add items to the index for a connector.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSearchExternalConnection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Unique identifier of the external connection in Microsoft Search. If not provided, all connections will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Unique identifier of the external connection in Microsoft Search. If not provided, all connections will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchExternalConnection ```</maml:para> <maml:para>This will return all connections to external datasources that are being indexed into Microsoft Search that exist within the tenant.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchExternalConnection -Identity "pnppowershell" ```</maml:para> <maml:para>This will return the connection to the external datasource with the specified identity that is being indexed into Microsoft Search.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSearchExternalItem</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: ExternalItem.Read.All under a delegated context. Note that ExternalItem.ReadWrite.All will not work. Application context is not supported. Returns the external items indexed for a specific connector in Microsoft Search</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSearchExternalItem</command:noun> </command:details> <maml:description> <maml:para>This cmdlet can be used to retrieve a list of indexed external items for a specific Microsoft Search external connector. The cmdlet will return all indexed external items for the specified connector. If you want to retrieve a specific external item, you can use the Identity parameter to specify the unique identifier of the external item. It uses a Microsoft Graph query in the background to retrieve the external items. This is why it will be unable to return the Access Control Lists (ACLs) information in the external items and the properties to contain more properties than you ingested yourself.</maml:para> <maml:para>It is only possible to run this cmdlet under a delegated context, application context is not supported by the Microsoft Graph search API endpoint for this type of query.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSearchExternalItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>ConnectionId</maml:name> <maml:description> <maml:para>The Connection ID or connection instance of the custom connector to use. This is the ID that was entered when registering the custom connector and will indicate for which custom connector the external items will be returned from the Microsoft Search index.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SearchExternalConnectionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Unique identifier of the external item in Microsoft Search. You can provide any identifier you want to retrieve or check for a specific item in the index. If you omit it, all external items for the specified connector will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="" aliases="none"> <maml:name>ConnectionId</maml:name> <maml:description> <maml:para>The Connection ID or connection instance of the custom connector to use. This is the ID that was entered when registering the custom connector and will indicate for which custom connector the external items will be returned from the Microsoft Search index.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SearchExternalConnectionPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Unique identifier of the external item in Microsoft Search. You can provide any identifier you want to retrieve or check for a specific item in the index. If you omit it, all external items for the specified connector will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchExternalItem -ConnectionId "pnppowershell" -ItemId "12345" ```</maml:para> <maml:para>This will return the external item with the unique identifier "12345" for the custom connector with the Connection ID "pnppowershell".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchExternalItem -ConnectionId "pnppowershell" ```</maml:para> <maml:para>This will return all external items for the custom connector with the Connection ID "pnppowershell".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Graph documentation</maml:linkText> <command:uri>https://learn.microsoft.com/graph/search-concept-custom-types#example-1-retrieve-items-using-azure-sql-built-in-connector</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSearchExternalSchema</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of ExternalConnection.ReadWrite.OwnedBy, ExternalConnection.Read.All, ExternalConnection.ReadWrite.All Retrieves the schema set on a connection to an external datasource belonging to Microsoft Search</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSearchExternalSchema</command:noun> </command:details> <maml:description> <maml:para>This cmdlet can be used to retrieve the current schema set on a connection to an external datasource that is being indexed into Microsoft Search through a custom connector.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSearchExternalSchema</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ConnectionId</maml:name> <maml:description> <maml:para>Unique identifier or instance of the external connection in Microsoft Search to retrieve the schema for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing [Get-PnPConnection](Get-PnPConnection.md).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ConnectionId</maml:name> <maml:description> <maml:para>Unique identifier or instance of the external connection in Microsoft Search to retrieve the schema for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchExternalSchema -ConnectionId "pnppowershell" ```</maml:para> <maml:para>This will return the current schema being used on the external Microsoft Search connection with the specified identity.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSearchSettings</command:name> <maml:description> <maml:para>Retrieves search settings for a site</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSearchSettings</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve search settings for a site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSearchSettings</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSearchSettings ```</maml:para> <maml:para>Retrieve search settings for the site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPServiceCurrentHealth</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : ServiceHealth.Read.All Gets current service status of the Office 365 Services from the Microsoft Graph API</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPServiceCurrentHealth</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve current service status of the Office 365 Services from the Microsoft Graph API.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPServiceCurrentHealth</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Allows retrieval of the current service status of only one particular service. If not provided, the current service status of all services will be returned. Note that you need to use the full name of the service, not the shortened Id.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Identity</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Allows retrieval of the current service status of only one particular service. If not provided, the current service status of all services will be returned. Note that you need to use the full name of the service, not the shortened Id.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Identity</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPServiceCurrentHealth ```</maml:para> <maml:para>Retrieves the current service status of all Office 365 services</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPServiceCurrentHealth -Identity "SharePoint Online" ```</maml:para> <maml:para>Retrieves the current service status of SharePoint Online</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPServiceHealthIssue</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : ServiceHealth.Read.All Gets service health issues of the Office 365 Services from the Microsoft Graph API</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPServiceHealthIssue</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve current service health issues of the Office 365 Services from the Microsoft Graph API.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPServiceHealthIssue</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">Identity</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">Identity</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPServiceHealthIssue ```</maml:para> <maml:para>Retrieves all the available service health issues</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPServiceHealthIssue -Identity "EX123456" ```</maml:para> <maml:para>Retrieves the details of the service health issue with the Id EX123456</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSharePointAddIn</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Returns the list of SharePoint addins installed in the site collection</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSharePointAddIn</command:noun> </command:details> <maml:description> <maml:para>## EXAMPLES</maml:para> <maml:para>### EXAMPLE 1 ```powershell Get-PnPSharePointAddIn ```</maml:para> <maml:para>Returns the SharePoint addins installed in your site collection</maml:para> <maml:para>### EXAMPLE 2 ```powershell Get-PnPSharePointAddIn -IncludeSubsites ```</maml:para> <maml:para>Returns the SharePoint addins installed in your site collection as well as the subsites.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSharePointAddIn</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSubsites</maml:name> <maml:description> <maml:para>When specified, it determines whether we should use also search the subsites of the connected site collection and lists the installed AddIns.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSubsites</maml:name> <maml:description> <maml:para>When specified, it determines whether we should use also search the subsites of the connected site collection and lists the installed AddIns.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSharePointAddIn ```</maml:para> <maml:para>Returns the SharePoint addins installed in your site collection</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSharePointAddIn -IncludeSubsites ```</maml:para> <maml:para>Returns the SharePoint addins installed in your site collection as well as the subsites.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSharingForNonOwnersOfSite</command:name> <maml:description> <maml:para>Returns $false if sharing of the site and items in the site is restricted only to owners or $true if members and owners are allowed to share</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSharingForNonOwnersOfSite</command:noun> </command:details> <maml:description> <maml:para>Returns $false if sharing of the site and items in the site is restricted only to owners or $true if members and owners are allowed to share. You can disable sharing by non owners by using Disable-PnPSharingForNonOwnersOfSite. At this point there is no interface available yet to enable sharing by owners and members again through script. You will have to do so through the user interface of SharePoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSharingForNonOwnersOfSite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSharingForNonOwnersOfSite ```</maml:para> <maml:para>Returns $false if sharing of the site and items in the site is restricted only to owners or $true if members and owners are allowed to share</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSite</command:name> <maml:description> <maml:para>Returns the current site collection from the context.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSite</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve current site collection from the context.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned site which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned site which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSite ```</maml:para> <maml:para>Gets the current site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSite -Includes RootWeb,ServerRelativeUrl ```</maml:para> <maml:para>Gets the current site specifying to include RootWeb and ServerRelativeUrl properties. For the full list of properties see https://learn.microsoft.com/previous-versions/office/sharepoint-server/ee538579(v%3doffice.15)</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteAnalyticsData</command:name> <maml:description> <maml:para>Retrieves analytics data for a site.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteAnalyticsData</command:noun> </command:details> <maml:description> <maml:para>Retrieves site analytics data within a specific date range.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteAnalyticsData</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The URL (server or site relative) of the site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>When specified, it will retrieve all analytics data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AnalyticsAggregationInterval</maml:name> <maml:description> <maml:para>When specified, it will retrieve analytics data with specified aggregation interval. Default is day. Allowed values are `Day`,`Week` and `Month`.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>When specified, it will retrieve analytics data ending with specified end date. Should be used along with StartDate parameter</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The URL (server or site relative) of the site</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LastSevenDays</maml:name> <maml:description> <maml:para>When specified, it will retrieve analytics data for the last seven days.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>When specified, it will retrieve analytics data starting from the specified start date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DateTime</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteAnalyticsData -All ```</maml:para> <maml:para>Retrieves all available analytics data for the specified site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteAnalyticsData -LastSevenDays ```</maml:para> <maml:para>Retrieves analytics data for the last seven days of the site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteAnalyticsData -StartDate (Get-date).AddDays(-15) -EndDate (Get-date) -AnalyticsAggregationInterval Day ```</maml:para> <maml:para>Retrieves analytics data for the last 15 days of the specified site with aggregation interval as days.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteAnalyticsData -Identity "https://tenant.sharepoint.com/sites/mysite" -StartDate (Get-date).AddDays(-15) -EndDate (Get-date) -AnalyticsAggregationInterval Day ```</maml:para> <maml:para>Retrieves analytics data, for the specified site, for the last 15 days of the specified site with aggregation interval as days.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Get</command:verb> <command:noun>PnPSiteClosure</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve current site closure status of the site which has a site policy applied.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteClosure</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteClosure ```</maml:para> <maml:para>Get the site closure status of the site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Get</command:verb> <command:noun>PnPSiteCollectionAdmin</command:noun> </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" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteCollectionAdmin ```</maml:para> <maml:para>This will return all the current site collection administrators of the site collection in the current context</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteCollectionAppCatalog</command:name> <maml:description> <maml:para>Returns all site collection scoped app catalogs that exist on the tenant</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteCollectionAppCatalog</command:noun> </command:details> <maml:description> <maml:para>Returns all the site collection scoped app catalogs that exist on the tenant</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteCollectionAppCatalog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CurrentSite</maml:name> <maml:description> <maml:para>When provided, it will check if the currently connected to site has a site collection App Catalog and will return information on it. If the current site holds no site collection App Catalog, an empty response will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeDeletedSites</maml:name> <maml:description> <maml:para>When provided, all site collections having site collection App Catalogs but residing in the tenant recycle bin, will be excluded</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipUrlValidation</maml:name> <maml:description> <maml:para>When provided, the site collection app catalog Urls will not be validated for if they have been renamed since their creation. This makes the cmdlet a lot faster, but it could also lead to URLs being returned that no longer exist. If not provided, for each site collection app catalog, it will look up the actual URL of the site collection app catalog and return that instead of the URL that was used when the site collection app catalog was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>CurrentSite</maml:name> <maml:description> <maml:para>When provided, it will check if the currently connected to site has a site collection App Catalog and will return information on it. If the current site holds no site collection App Catalog, an empty response will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ExcludeDeletedSites</maml:name> <maml:description> <maml:para>When provided, all site collections having site collection App Catalogs but residing in the tenant recycle bin, will be excluded</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SkipUrlValidation</maml:name> <maml:description> <maml:para>When provided, the site collection app catalog Urls will not be validated for if they have been renamed since their creation. This makes the cmdlet a lot faster, but it could also lead to URLs being returned that no longer exist. If not provided, for each site collection app catalog, it will look up the actual URL of the site collection app catalog and return that instead of the URL that was used when the site collection app catalog was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteCollectionAppCatalog ``` Will return all the site collection app catalogs that exist on the tenant, including those that may be in the tenant recycle bin</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteCollectionAppCatalog -CurrentSite ``` Will return the site collection app catalog for the currently connected to site, if it has one. Otherwise it will yield no result.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteCollectionAppCatalog -ExcludeDeletedSites ``` Will return all the site collection app catalogs that exist on the tenant excluding the site collections having App Catalogs that are in the tenant recycle bin</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteCollectionTermStore</command:name> <maml:description> <maml:para>Returns the site collection term store if it exists or else it will not return anything</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteCollectionTermStore</command:noun> </command:details> <maml:description> <maml:para>Returns the site collection scoped term store for the currently connected to site collection. If it does not exist yet, it will return a null value.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteCollectionTermStore</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteCollectionTermStore ```</maml:para> <maml:para>Returns the site collection term store.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteDesign</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Retrieve Site Designs that have been registered on the current tenant.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteDesign</command:noun> </command:details> <maml:description> <maml:para>Retrieve Site Designs that have been registered on the current tenant. When providing a name with -Identity, it returns all site designs with that name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteDesign</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified will retrieve the specified site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified will retrieve the specified site design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteDesign ```</maml:para> <maml:para>Returns all registered site designs</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteDesign -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd ```</maml:para> <maml:para>Returns a specific registered site designs</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteDesignRights</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Returns the principals with design rights on a specific Site Design</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteDesignRights</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve the principals with design rights on a specific Site Design.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteDesignRights</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the Site Design to receive the rights for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the Site Design to receive the rights for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteDesignRights -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd ```</maml:para> <maml:para>Returns the principals with rights on a specific site design</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteDesignRun</command:name> <maml:description> <maml:para>Retrieves a list of site designs applied to a specified site collection. If the WebUrl parameter is not specified we show the list of designs applied to the current site. The returned output includes the ID of the scheduled job, the web and site IDs, and the site design ID, version, and title.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteDesignRun</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve a list of site designs applied to a specified site collection. By default the command will retrieve list of designs applied to the current site but it is also possible to get this information from a different site collection using `WebUrl` option.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteDesignRun</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para>The ID of the site design to apply.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the site collection where the site design will be applied. If not specified the design will be applied to the site you connected to with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteDesignId</maml:name> <maml:description> <maml:para>The ID of the site design to apply.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the site collection where the site design will be applied. If not specified the design will be applied to the site you connected to with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteDesignRun ```</maml:para> <maml:para>This example returns a list of the site designs applied to the current site. Providing a specific site design ID will return the details for just that applied site design.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteDesignRun -WebUrl "https://mytenant.sharepoint.com/sites/project" ```</maml:para> <maml:para>This example returns a list of the site designs applied to the specified site. Providing a specific site design ID will return the details for just that applied site design.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteDesignRunStatus</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Retrieves and displays a list of all site script actions executed for a specified site design applied to a site.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteDesignRunStatus</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve a list of all site script actions executed for a specified site design applied to a site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteDesignRunStatus</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Run</maml:name> <maml:description> <maml:para>The site design run for the desired set of script action details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TenantSiteDesignRun</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Run</maml:name> <maml:description> <maml:para>The site design run for the desired set of script action details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TenantSiteDesignRun</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell $myrun = Get-PnPSiteDesignRun -WebUrl "https://contoso.sharepoint.com/sites/project-playbook" -SiteDesignId cefd782e-sean-4814-a68a-b33b116c302f Get-PnPSiteDesignRunStatus -Run $myrun ```</maml:para> <maml:para>This example gets the run for a specific site design applied to a site and sets it to a variable. This variable is then passed into the command -Run parameter. The result is a display of all the site script actions applied for that site design run, including the script action title and outcome.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteDesignTask</command:name> <maml:description> <maml:para>Used to retrieve a scheduled site design script. It takes the ID of the scheduled site design task and the URL for the site where the site design is scheduled to be applied.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteDesignTask</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve a scheduled site design script.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteDesignTask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the site design task to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantSiteDesignTaskPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the site collection where the site design will be applied. If not specified the site design tasks will be returned for the site you connected to with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The ID of the site design task to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantSiteDesignTaskPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>The URL of the site collection where the site design will be applied. If not specified the site design tasks will be returned for the site you connected to with Connect-PnPOnline.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteDesignTask -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 ```</maml:para> <maml:para>This example retrieves a site design task given the provided site design task id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteDesignTask ```</maml:para> <maml:para>This example retrieves all site design tasks currently scheduled on the current site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteDesignTask -WebUrl "https://contoso.sharepoint.com/sites/project" ```</maml:para> <maml:para>This example retrieves all site design tasks currently scheduled on the provided site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteFileVersionBatchDeleteJobStatus</command:name> <maml:description> <maml:para>Get the progress of deleting existing file versions on the site.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteFileVersionBatchDeleteJobStatus</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows retrieval of the progress of deleting existing file versions on the site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteFileVersionBatchDeleteJobStatus</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteFileVersionBatchDeleteJobStatus ```</maml:para> <maml:para>Returns the progress of deleting existing file versions on the site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteFileVersionExpirationReportJobStatus</command:name> <maml:description> <maml:para>Gets the status for a file version usage report generation job for a site collection.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteFileVersionExpirationReportJobStatus</command:noun> </command:details> <maml:description> <maml:para>Gets the status for a file version usage report generation job for a site collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteFileVersionExpirationReportJobStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReportUrl</maml:name> <maml:description> <maml:para>The URL of the report to get the job status on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ReportUrl</maml:name> <maml:description> <maml:para>The URL of the report to get the job status on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteFileVersionExpirationReportJobStatus -ReportUrl "https://contoso.sharepoint.com/sites/reports/MyReports/VersionReport.csv" ```</maml:para> <maml:para>Gets the status for a file version usage report generation job for a site collection.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteGroup</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Gets all the groups in the current or specified site collection.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteGroup</command:noun> </command:details> <maml:description> <maml:para>Use the Get-PnPSiteGroup cmdlet to get all the groups on the specified or currently connected site collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteGroup </maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the group name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>Retrieve the associated member group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Specifies the group name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>Retrieve the associated member group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteGroup ```</maml:para> <maml:para>Returns all SharePoint groups in the current connected to site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteGroup -Site "https://contoso.sharepoint.com/sites/siteA" ``` This will return all SharePoint groups in the specified site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteGroup -Group "SiteA Members" ``` This will return the specified group for the current connected to site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteGroup -Group "SiteA Members" -Site "https://contoso.sharepoint.com/sites/siteA" ``` This will return the specified group for the specified site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSitePolicy</command:name> <maml:description> <maml:para>Retrieves all or a specific site policy</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSitePolicy</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve site policies.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSitePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AllAvailable</maml:name> <maml:description> <maml:para>Retrieve all available site policies</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>AllAvailable</maml:name> <maml:description> <maml:para>Retrieve all available site policies</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSitePolicy ```</maml:para> <maml:para>Retrieves the current applied site policy.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSitePolicy -AllAvailable ```</maml:para> <maml:para>Retrieves all available site policies.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSitePolicy -Name "Contoso HBI" ```</maml:para> <maml:para>Retrieves an available site policy with the name "Contoso HBI".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteScript</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Retrieve Site Scripts that have been registered on the current tenant.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteScript</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve site scripts registered on the current tenant. By using `Identity` option it is possible to retrieve specified site script</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteScript</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified will retrieve the specified site script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantSiteScriptPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>SiteDesign</maml:name> <maml:description> <maml:para>If specified will retrieve the site scripts for this design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>If specified will retrieve the specified site script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantSiteScriptPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>SiteDesign</maml:name> <maml:description> <maml:para>If specified will retrieve the site scripts for this design</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TenantSiteDesignPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteScript ```</maml:para> <maml:para>Returns all registered site scripts</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteScript -Identity 5c73382d-9643-4aa0-9160-d0cba35e40fd ```</maml:para> <maml:para>Returns a specific registered site script</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteScriptFromList</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Generates a Site Script from an existing list</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteScriptFromList</command:noun> </command:details> <maml:description> <maml:para>This command allows a Site Script to be generated off of an existing list on your tenant. The script will return the JSON syntax with the definition of the list, including fields, views, content types, and some of the list settings. The script can then be used with [Add-PnPSiteScript](Add-PnPSiteScript.md) and [Add-PnPListDesign](Add-PnPListDesign.md) to allow lists with the same configuration as the original list to be created by end users.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteScriptFromList</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>Specifies an instance, Id or, title of the list to generate a Site Script from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPSiteScriptFromList</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the full URL of the list to generate a Site Script from. I.e. https://contoso.sharepoint.com/sites/teamsite/lists/MyList</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>Specifies an instance, Id or, title of the list to generate a Site Script from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ListPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the full URL of the list to generate a Site Script from. I.e. https://contoso.sharepoint.com/sites/teamsite/lists/MyList</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Verbose</maml:name> <maml:description> <maml:para>When provided, additional debug statements will be shown while executing the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteScriptFromList -List "MyList" ```</maml:para> <maml:para>Returns the generated Site Script JSON from the list "MyList" in the currently connected to site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPList -Identity "MyList" | Get-PnPSiteScriptFromList | Add-PnPSiteScript -Title "MyListScript" | Add-PnPListDesign -Title "MyListDesign" ```</maml:para> <maml:para>Returns the generated Site Script JSON from the list "MyList" in the currently connected to site and registers it as a new Site Script with the title "MyListScript" and uses that Site Script to register a new List Design with the title "MyListDesign"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteScriptFromList -Url "https://contoso.sharepoint.com/sites/teamsite/lists/MyList" ```</maml:para> <maml:para>Returns the generated Site Script JSON from the list "MyList" at the provided Url</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteScriptFromList -Url "https://contoso.sharepoint.com/sites/teamsite/Shared Documents" ```</maml:para> <maml:para>Returns the generated Site Script JSON from the default document library at the provided Url</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteScriptFromWeb</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Generates a Site Script from an existing site</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteScriptFromWeb</command:noun> </command:details> <maml:description> <maml:para>This command allows a Site Script to be generated off of an existing site on your tenant. You need to provide at least one of the optional Include or Lists arguments. If you omit the URL, the Site Script will be created from the site to which you are connected.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteScriptFromWeb</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeAll</maml:name> <maml:description> <maml:para>If specified will include all supported components into the Site Script including all self lists, branding, navigation links, regional settings, external sharing capability and theme.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Lists</maml:name> <maml:description> <maml:para>Allows specifying one or more site relative URLs of lists that should be included into the Site Script, i.e. "Shared Documents","Lists\MyList"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site to generate a Site Script from. If omitted, the currently connected to site will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPSiteScriptFromWeb</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeBranding</maml:name> <maml:description> <maml:para>If specified will include the branding of the site into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeLinksToExportedItems</maml:name> <maml:description> <maml:para>If specified will include navigation links into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeRegionalSettings</maml:name> <maml:description> <maml:para>If specified will include the regional settings into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSiteExternalSharingCapability</maml:name> <maml:description> <maml:para>If specified will include the external sharing configuration into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeTheme</maml:name> <maml:description> <maml:para>If specified will include the branding of the site into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Lists</maml:name> <maml:description> <maml:para>Allows specifying one or more site relative URLs of lists that should be included into the Site Script, i.e. "Shared Documents","Lists\MyList"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site to generate a Site Script from. If omitted, the currently connected to site will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPSiteScriptFromWeb</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeAllLists</maml:name> <maml:description> <maml:para>If specified, all lists that are not hidden, private, internal or catalogs will be included into the Site Script. It cannot be combined with the -Lists nor the -IncludeAll parameters as both will already include all lists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeBranding</maml:name> <maml:description> <maml:para>If specified will include the branding of the site into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeLinksToExportedItems</maml:name> <maml:description> <maml:para>If specified will include navigation links into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeRegionalSettings</maml:name> <maml:description> <maml:para>If specified will include the regional settings into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSiteExternalSharingCapability</maml:name> <maml:description> <maml:para>If specified will include the external sharing configuration into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeTheme</maml:name> <maml:description> <maml:para>If specified will include the branding of the site into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site to generate a Site Script from. If omitted, the currently connected to site will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeAll</maml:name> <maml:description> <maml:para>If specified will include all supported components into the Site Script including all self lists, branding, navigation links, regional settings, external sharing capability and theme.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeAllLists</maml:name> <maml:description> <maml:para>If specified, all lists that are not hidden, private, internal or catalogs will be included into the Site Script. It cannot be combined with the -Lists nor the -IncludeAll parameters as both will already include all lists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeBranding</maml:name> <maml:description> <maml:para>If specified will include the branding of the site into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeLinksToExportedItems</maml:name> <maml:description> <maml:para>If specified will include navigation links into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeRegionalSettings</maml:name> <maml:description> <maml:para>If specified will include the regional settings into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeSiteExternalSharingCapability</maml:name> <maml:description> <maml:para>If specified will include the external sharing configuration into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeTheme</maml:name> <maml:description> <maml:para>If specified will include the branding of the site into the Site Script</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Lists</maml:name> <maml:description> <maml:para>Allows specifying one or more site relative URLs of lists that should be included into the Site Script, i.e. "Shared Documents","Lists\MyList"</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the site to generate a Site Script from. If omitted, the currently connected to site will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteScriptFromWeb -IncludeAll ```</maml:para> <maml:para>Returns the generated Site Script JSON containing all supported components from the currently connected to site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteScriptFromWeb -Url "https://contoso.sharepoint.com/sites/teamsite" -IncludeAll ```</maml:para> <maml:para>Returns the generated Site Script JSON containing all supported components from the site at the provided Url</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteScriptFromWeb -Url "https://contoso.sharepoint.com/sites/teamsite" -IncludeAll -Lists "Shared Documents","Lists\MyList" ```</maml:para> <maml:para>Returns the generated Site Script JSON containing all supported components from the site at the provided Url including the lists "Shared Documents" and "MyList"</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteScriptFromWeb -Url "https://contoso.sharepoint.com/sites/teamsite" -IncludeBranding -IncludeLinksToExportedItems ```</maml:para> <maml:para>Returns the generated Site Script JSON containing the branding and navigation links from the site at the provided Url</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteScriptFromWeb -IncludeAllLists ```</maml:para> <maml:para>Returns the generated Site Script JSON containing all lists from the currently connected to site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteScriptFromWeb -IncludeAllLists | Add-PnPSiteScript -Title "My Site Script" | Add-PnPSiteDesign -Title "My Site Design" -WebTemplate TeamSite ```</maml:para> <maml:para>Creates a new site script and site design based on the currently connected to site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <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> <command:verb>Get</command:verb> <command:noun>PnPSiteSearchQueryResults</command:noun> </command:details> <maml:description> <maml:para>Allows to run a search query to retrieve indexed site collections.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteSearchQueryResults</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PnPSiteSearchQueryResults</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Int32</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteSearchQueryResults ```</maml:para> <maml:para>Returns the top 500 site collections indexed by SharePoint Search</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteSearchQueryResults -Query "WebTemplate:STS" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteSearchQueryResults -Query "WebTemplate:SPSPERS" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteSearchQueryResults -Query "Title:Intranet*" ```</maml:para> <maml:para>Returns the top 500 site collections indexed by SharePoint Search of which the title starts with the word Intranet</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteSearchQueryResults -MaxResults 10 ```</maml:para> <maml:para>Returns the top 10 site collections indexed by SharePoint Search</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteSearchQueryResults -All ```</maml:para> <maml:para>Returns absolutely all site collections indexed by SharePoint Search</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteSensitivityLabel</command:name> <maml:description> <maml:para>Gets the Microsoft Purview sensitivity label that is set on the connected to site</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteSensitivityLabel</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows retrieval of the currently assigned Microsoft Purview sensitivity label to the currently connected to site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteSensitivityLabel</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteSensitivityLabel ```</maml:para> <maml:para>Returns the Microsoft Purview sensitivity label set on the currently connected to site</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Docs documentation</maml:linkText> <command:uri>https://learn.microsoft.com/sharepoint/dev/solution-guidance/modern-experience-site-classification#programmatically-read-the-classification-of-a-site</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteTemplate</command:name> <maml:description> <maml:para>Generates a provisioning site template from a web</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteTemplate</command:noun> </command:details> <maml:description> <maml:para>Allows to generate a provisioning site template from a web.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ExtractConfigurationPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ExtensibilityHandler[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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://learn.microsoft.com/dotnet/api/officedevpnp.core.framework.provisioning.model.handlers</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeAllPages</maml:name> <maml:description> <maml:para>If specified all site pages will be included</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ListsToExtract</maml:name> <maml:description> <maml:para>Specify the lists to extract, either providing their ID or their Title.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Collections.Generic.List`1[System.String]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>NoBaseTemplate</maml:name> <maml:description> <maml:para>{{ Fill NoBaseTemplate Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path. The format of the file is based upon the extension you specify. - .xml will generate an XML file - .pnp will generate a PnP Provisioning Package, which is a file that contains all artifacts in a single archive (files, images, etc.) - .md will generate a user readable markdown report. This is work in progress and will be extended in the future.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OutputInstance</maml:name> <maml:description> <maml:para>Returns the template as an in-memory object, which is an instance of the SiteTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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.&lt;language&gt;.resx. See examples for more info.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <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" variableLength="true">XMLPnPSchemaVersion</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specify a JSON configuration file to configure the extraction progress.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ExtractConfigurationPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Encoding</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ExtensibilityHandler[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrites the output file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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://learn.microsoft.com/dotnet/api/officedevpnp.core.framework.provisioning.model.handlers</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Handlers</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeAllPages</maml:name> <maml:description> <maml:para>If specified all site pages will be included</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ListsToExtract</maml:name> <maml:description> <maml:para>Specify the lists to extract, either providing their ID or their Title.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Collections.Generic.List`1[System.String]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>NoBaseTemplate</maml:name> <maml:description> <maml:para>{{ Fill NoBaseTemplate Description }}</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write to, optionally including full path. The format of the file is based upon the extension you specify. - .xml will generate an XML file - .pnp will generate a PnP Provisioning Package, which is a file that contains all artifacts in a single archive (files, images, etc.) - .md will generate a user readable markdown report. This is work in progress and will be extended in the future.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OutputInstance</maml:name> <maml:description> <maml:para>Returns the template as an in-memory object, which is an instance of the SiteTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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.&lt;language&gt;.resx. See examples for more info.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <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" variableLength="true">XMLPnPSchemaVersion</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">ITemplateProviderExtension[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteTemplate -Out template.pnp ```</maml:para> <maml:para>Extracts a provisioning template in Office Open XML from the current web.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteTemplate -Out template.xml ```</maml:para> <maml:para>Extracts a provisioning template in XML format from the current web.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteTemplate -Out template.md ```</maml:para> <maml:para>Extracts a provisioning template in readable markdown format.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteTemplate -Out template.pnp -Schema V201503 ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteTemplate -Out template.pnp -IncludeAllTermGroups ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 6 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteTemplate -Out template.pnp -IncludeSiteCollectionTermGroup ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 7 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteTemplate -Out template.pnp -PersistBrandingFiles ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 8 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteTemplate -Out template.pnp -Handlers Lists, SiteSecurity ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 9 ---------</maml:title> <maml:introduction> <maml:para>```powershell $handler1 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1 $handler2 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler2 Get-PnPSiteTemplate -Out NewTemplate.xml -ExtensibilityHandlers $handler1,$handler2 ```</maml:para> <maml:para>This will create two new ExtensibilityHandler objects that are run during extraction of the template</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </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:para>```powershell Get-PnPSiteTemplate -Out template.pnp -PersistMultiLanguageResources ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 11 ---------</maml:title> <maml:introduction> <maml:para>Only supported on SP2016, SP2019 and SP Online</maml:para> <maml:para>```powershell Get-PnPSiteTemplate -Out template.pnp -PersistMultiLanguageResources -ResourceFilePrefix MyResources ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 12 ---------</maml:title> <maml:introduction> <maml:para>```powershell $template = Get-PnPSiteTemplate -OutputInstance ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 13 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteTemplate -Out template.pnp -ContentTypeGroups "Group A","Group B" ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 14 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteTemplate -Out template.pnp -ExcludeContentTypesFromSyndication ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 15 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteTemplate -Out template.pnp -ListsToExtract "Title of List One","95c4efd6-08f4-4c67-94ae-49d696ba1298","Title of List Three" ```</maml:para> <maml:para>Extracts a provisioning template in Office Open XML from the current web, including only the lists specified by title or ID.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 16 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteTemplate -Out template.xml -Handlers Fields, ContentTypes, SupportedUILanguages -PersistMultiLanguageResources ```</maml:para> <maml:para>Extracts a provisioning template in XML format from the current web including the fields, content types and supported ui languages. It will create a resource file for each supported language. The generated resource files will be named 'template.en-US.resx' etc. It is mandatory to include the "SupportedUILanguages" for these handlers as otherwise the resource files will not be created.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 17 ---------</maml:title> <maml:introduction> <maml:para>```powershell Connect-PnPOnline -Url "https://contoso.sharepoint.com/sites/yourContentCenter"</maml:para> <maml:para>Get-PnPSiteTemplate -Out MyModels.pnp -Handlers SyntexModels ```</maml:para> <maml:para>Export all Syntex Document Understanding models in a Content Center into a single PnP template. Note that only unstructured document processing models can be imported from a PnP template.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Encoding documentation</maml:linkText> <command:uri>https://learn.microsoft.com/dotnet/api/system.text.encoding?view=net-8.0</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteUserInvitations</command:name> <maml:description> <maml:para>**Required Permissions** * SharePoint: Access to the SharePoint Tenant Administration site Searches against all stored sharing links and retrieves the email invites</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteUserInvitations</command:noun> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteUserInvitations</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Email Address of the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>Specifies the URL of the site collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Email Address of the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Site</maml:name> <maml:description> <maml:para>Specifies the URL of the site collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SitePipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteUserInvitations -Site "https://contoso.sharepoint.com/sites/ContosoWeb1/" -EmailAddress someone@example.com ```</maml:para> <maml:para>This example retrieves email invites stored in the ContosoWeb1 site to the user with email address someone@example.com.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteVersionPolicy</command:name> <maml:description> <maml:para>Get version policy setting of the site. **Required Permissions** | Type | API/ Permission Name | Admin consent required | | --------------- | --------------------------------------- | -------- | | Delegated | AllSites.FullControl | yes |</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteVersionPolicy</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows retrieval of version policy setting on the site. When the new document libraries are created, they will be set as the version policy of the site. If the version policy is not set on the site, the setting of the tenant will be used.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteVersionPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteVersionPolicy ```</maml:para> <maml:para>Returns the version policy setting of the site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Docs documentation</maml:linkText> <command:uri>https://learn.microsoft.com/sharepoint/dev/solution-guidance/modern-experience-site-classification#programmatically-read-the-classification-of-a-site</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSiteVersionPolicyStatus</command:name> <maml:description> <maml:para>Get the progress of setting version policy for existing document libraries on the site.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSiteVersionPolicyStatus</command:noun> </command:details> <maml:description> <maml:para>This cmdlet allows retrieval of the progress of setting version policy for existing document libraries on the site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSiteVersionPolicyStatus</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSiteVersionPolicyStatus ```</maml:para> <maml:para>Returns the progress of setting version policy for existing document libraries on the site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Microsoft Docs documentation</maml:linkText> <command:uri>https://learn.microsoft.com/sharepoint/dev/solution-guidance/modern-experience-site-classification#programmatically-read-the-classification-of-a-site</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPStorageEntity</command:name> <maml:description> <maml:para>Retrieve Storage Entities / Farm Properties from either the Tenant App Catalog or from the current site if it has a site scope app catalog.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPStorageEntity</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve storage entities from either tenant app catalog or current site app catalog.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPStorageEntity</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the value to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines the scope of the storage entity. Defaults to Tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">StorageEntityScope</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Key</maml:name> <maml:description> <maml:para>The key of the value to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Defines the scope of the storage entity. Defaults to Tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">StorageEntityScope</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPStorageEntity ```</maml:para> <maml:para>Returns all site storage entities/farm properties</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPStorageEntity -Key MyKey ```</maml:para> <maml:para>Returns the storage entity/farm property with the given key.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPStorageEntity -Scope Site ```</maml:para> <maml:para>Returns all site collection scoped storage entities</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPStorageEntity -Key MyKey -Scope Site ```</maml:para> <maml:para>Returns the storage entity from the site collection with the given key</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPStoredCredential</command:name> <maml:description> <maml:para>Get a credential</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPStoredCredential</command:noun> </command:details> <maml:description> <maml:para>Returns a stored credential from the Windows Credential Manager or Mac OS Key Chain Entry.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPStoredCredential</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The credential to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The credential to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPStoredCredential -Name O365 ```</maml:para> <maml:para>Returns the credential associated with the specified identifier</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPStructuralNavigationCacheSiteState</command:name> <maml:description> <maml:para>Get the structural navigation caching state for a site collection.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPStructuralNavigationCacheSiteState</command:noun> </command:details> <maml:description> <maml:para>The Get-PnPStructuralNavigationCacheSiteState cmdlet can be used to determine if structural navigation caching is enabled or disabled for a site collection. If the SiteUrl parameter has not been specified the currently connected to site will be used.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPStructuralNavigationCacheSiteState</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>Specifies the absolute URL for the site collection's root web being checked for its caching state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>SiteUrl</maml:name> <maml:description> <maml:para>Specifies the absolute URL for the site collection's root web being checked for its caching state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPStructuralNavigationCacheSiteState -SiteUrl "https://contoso.sharepoint.com/sites/product/" ```</maml:para> <maml:para>This example checks if structural navigation caching is enabled for the entire site collection https://contoso.sharepoint.com/sites/product/. If caching is enabled, then it will return True. If caching is disabled, then it will return False.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPStructuralNavigationCacheWebState</command:name> <maml:description> <maml:para>Get the structural navigation caching state for a web.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPStructuralNavigationCacheWebState</command:noun> </command:details> <maml:description> <maml:para>The Get-PnPStructuralNavigationCacheWebState cmdlet can be used to determine if structural navigation caching is enabled or disabled for a web in a site collection. If the WebUrl parameter has not been specified the currently connected to web will be used.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPStructuralNavigationCacheWebState</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>Specifies the absolute URL for the web being checked for its caching state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WebUrl</maml:name> <maml:description> <maml:para>Specifies the absolute URL for the web being checked for its caching state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPStructuralNavigationCacheWebState -WebUrl "https://contoso.sharepoint.com/sites/product/electronics" ```</maml:para> <maml:para>This example checks if structural navigation caching is enabled for the web https://contoso.sharepoint.com/sites/product/electronics. If caching is enabled, then it will return True. If caching is disabled, then it will return False.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSubWeb</command:name> <maml:description> <maml:para>Returns the subwebs of the current web</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSubWeb</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve subwebs of the current web.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSubWeb</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeRootWeb</maml:name> <maml:description> <maml:para>If provided, the results will also contain the root web</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned sub web which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">WebPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeRootWeb</maml:name> <maml:description> <maml:para>If provided, the results will also contain the root web</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Includes</maml:name> <maml:description> <maml:para>Optionally allows properties to be retrieved for the returned sub web which are not included in the response by default</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <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" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSubWeb ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSubWeb -Recurse ```</maml:para> <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:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSubWeb -Recurse -Includes "WebTemplate","Description" | Select ServerRelativeUrl, WebTemplate, Description ```</maml:para> <maml:para>Retrieves all subsites of the current context and shows the ServerRelativeUrl, WebTemplate and Description properties in the resulting output</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSubWeb -Identity Team1 -Recurse ```</maml:para> <maml:para>Retrieves all subsites of the subsite Team1 and all of its nested child subsites</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 5 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSubWeb -Identity Team1 -Recurse -IncludeRootWeb ```</maml:para> <maml:para>Retrieves the root web, all subsites of the subsite Team1 and all of its nested child subsites</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSyntexModel</command:name> <maml:description> <maml:para>Returns Microsoft Syntex models from a Syntex Content Center. This cmdlet only works when you've connected to a Syntex Content Center site.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSyntexModel</command:noun> </command:details> <maml:description> <maml:para>This command allows the retrieval of a Syntex document processing models defined in the connected Syntex Content Center site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSyntexModel</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name or id of the Syntex model.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SyntexModelPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The name or id of the Syntex model.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SyntexModelPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSyntexModel ```</maml:para> <maml:para>Lists all the document processing models in the connected Syntex Content Center site.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSyntexModel -Identity 1 ```</maml:para> <maml:para>Gets the document processing model with the id 1.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSyntexModel -Identity "Invoice model" ```</maml:para> <maml:para>Gets the document processing model named "Invoice model".</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPSyntexModelPublication</command:name> <maml:description> <maml:para>Returns the libraries to which a Microsoft Syntex model was published. This cmdlet only works when you've connected to a Syntex Content Center site.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPSyntexModelPublication</command:noun> </command:details> <maml:description> <maml:para>This command returns the libraries to which a Syntex document processing model defined in the connected Syntex Content Center site was published.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPSyntexModelPublications</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Model</maml:name> <maml:description> <maml:para>The name or id of the Syntex model.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SyntexModelPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Model</maml:name> <maml:description> <maml:para>The name or id of the Syntex model.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SyntexModelPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPSyntexModelPublication -Identity "Invoice model" ```</maml:para> <maml:para>Gets the libraries to which the document processing model named "Invoice model" was published.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPTaxonomyItem</command:name> <maml:description> <maml:para>Returns a taxonomy item</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPTaxonomyItem</command:noun> </command:details> <maml:description> <maml:para>Provide the term path only and then the term item if found will be returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTaxonomyItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <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" variableLength="true">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPTaxonomyItem -TermPath "My Term Group|My Term Set|Contoso" ```</maml:para> <maml:para>Will return the taxonomy item for the term path specified.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPTaxonomySession</command:name> <maml:description> <maml:para>Returns a taxonomy session</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPTaxonomySession</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve taxonomy session.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTaxonomySession</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PnPConnection</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPTeamsApp</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of AppCatalog.Read.All, Directory.ReadWrite.All Gets one Microsoft Teams App or a list of all apps.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPTeamsApp</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve Microsoft Teams apps. By using `Identity` option it is possible to retrieve a specific app.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTeamsApp</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the name, id or external id of the app.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TeamsAppPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Specify the name, id or external id of the app.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TeamsAppPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPTeamsApp ```</maml:para> <maml:para>Retrieves all the Microsoft Teams Apps</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPTeamsApp -Identity a54224d7-608b-4839-bf74-1b68148e65d4 ```</maml:para> <maml:para>Retrieves a specific Microsoft Teams App</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPTeamsApp -Identity "MyTeamsApp" ```</maml:para> <maml:para>Retrieves a specific Microsoft Teams App</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPTeamsChannel</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : One of Group.Read.All, Group.ReadWrite.All Gets the channels for a specified Team.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPTeamsChannel</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve list of channels for a specified team.</maml:para> <maml:para>Note that the ModerationSettings are only being returned when providing the channel Id of a specific channel through -Identity and by providing -IncludeModerationSettings (Example 4). They will not be returned when retrieving all channels for a team or when omitting -IncludeModerationSettings. This is because of a design choice in Microsoft Graph and the moderationsettings currently only being available through its beta endpoint, which will be used when -IncludeModerationSettings is provided.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTeamsChannel</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id or name of the channel to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TeamsChannelPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeModerationSettings</maml:name> <maml:description> <maml:para>When provided, it will use the beta endpoint of Microsoft Graph to retrieve the information. This will include the ModerationSettings if used in combination with -Identity <channelId>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Identity</maml:name> <maml:description> <maml:para>The id or name of the channel to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">TeamsChannelPipeBind</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>IncludeModerationSettings</maml:name> <maml:description> <maml:para>When provided, it will use the beta endpoint of Microsoft Graph to retrieve the information. This will include the ModerationSettings if used in combination with -Identity <channelId>.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPTeamsChannel -Team a6c1e0d7-f579-4993-81ab-4b666f8edea8 ```</maml:para> <maml:para>Retrieves all channels for the specified team</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPTeamsChannel -Team a6c1e0d7-f579-4993-81ab-4b666f8edea8 -Identity "Test Channel" ```</maml:para> <maml:para>Retrieves the channel called 'Test Channel'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 3 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPTeamsChannel -Team a6c1e0d7-f579-4993-81ab-4b666f8edea8 -Identity "19:796d063b63e34497aeaf092c8fb9b44e@thread.skype" ```</maml:para> <maml:para>Retrieves the channel specified by its channel id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 4 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPTeamsChannel -Team a6c1e0d7-f579-4993-81ab-4b666f8edea8 -Identity "19:796d063b63e34497aeaf092c8fb9b44e@thread.skype" -IncludeModerationSettings ```</maml:para> <maml:para>Retrieves the channel specified by its channel id which will include the ModerationSettings</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPTeamsChannelFilesFolder</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API : Group.Read.All Gets the metadata for the location where the files of a channel are stored.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPTeamsChannelFilesFolder</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve folder metadata for specified channel.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTeamsChannel</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>The id or name of the channel to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsChannelPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>The id or name of the channel to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsChannelPipeBind</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Specify the group id, mailNickname or display name of the team to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">TeamsTeamPipeBind</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPTeamsChannelFilesFolder -Team "Sales Team" -Channel "Test Channel" ```</maml:para> <maml:para>Retrieves the folder metadata for the channel called 'Test Channel' located in the Team named 'Sales Team'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>```powershell Get-PnPTeamsChannelFilesFolder -Team a6c1e0d7-f579-4993-81ab-4b666f8edea8 -Channel "19:796d063b63e34497aeaf092c8fb9b44e@thread.skype" ```</maml:para> <maml:para>Retrieves the folder metadata for the channel specified by its channel id</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft 365 Patterns and Practices</maml:linkText> <command:uri>https://aka.ms/m365pnp</command:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-PnPTeamsChannelMessage</command:name> <maml:description> <maml:para>**Required Permissions** * Microsoft Graph API: Group.ReadWrite.All Returns messages from the specified Microsoft Teams Channel.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>PnPTeamsChannelMessage</command:noun> </command:details> <maml:description> <maml:para>Allows to retrieve messages from the specified channel.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PnPTeamsChannelMessage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Specify id or name of the channel to use.</maml:para> </maml:description> <command:param |